3wordchant/oasis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
3758bbf636
oasis/docs/install.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

Change to organize install docs
2020-01-03 23:04:16 +00:00
# Install
This is a guide on how to download the source code for Oasis so that you can
Experiment with common-good module
2020-01-22 00:22:19 +00:00
build and install it on your computer. If you'd like an easier installation
Change to organize install docs
2020-01-03 23:04:16 +00:00
option, try one of the options in the readme.
If you want to run Oasis in the background, see [`with-systemd.md`](./with-systemd.md).
If you want to run Oasis in a container, see [`with-docker.md`](./with-docker.md).
Add Termux install documentation Problem: The Termux install is new and exciting and there isn't any documentation on how to experiment with it. Solution: Add some documentation like we've done with systemd and Docker so that we can collaborate and figure it out in the repo!
2020-02-20 23:12:38 +00:00
If you want to run Oasis on Android via Termux, see [`with-termux.md`](./with-termux.md).
Change to organize install docs
2020-01-03 23:04:16 +00:00
## Download
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
Download Oasis from GitHub over HTTPS.
Change to organize install docs
2020-01-03 23:04:16 +00:00
```shell
git clone https://github.com/fraction/oasis.git
```
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
## Install dependencies
Change to organize install docs
2020-01-03 23:04:16 +00:00
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
Most people should build and install Oasis with npm.
Change to organize install docs
2020-01-03 23:04:16 +00:00
```shell
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
cd oasis
npm install --only=prod
Change to organize install docs
2020-01-03 23:04:16 +00:00
```
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
## Start
Change to organize install docs
2020-01-03 23:04:16 +00:00
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
You can try Oasis without installing with:
Change to organize install docs
2020-01-03 23:04:16 +00:00
```shell
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
node .
Change to organize install docs
2020-01-03 23:04:16 +00:00
```
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
## Install globally
Change to organize install docs
2020-01-03 23:04:16 +00:00
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
If you want to install to make `oasis` available globally:
Change to organize install docs
2020-01-03 23:04:16 +00:00
```shell
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
npm -g install .
Change to organize install docs
2020-01-03 23:04:16 +00:00
```
Simplify installation Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source.
2020-02-29 16:31:07 +00:00
If you see a permission error, see [resolving EACCESS permission errors](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). If you any other problems, please [reach out for help](https://github.com/fraction/oasis/issues/new).
Reference in New Issue Copy Permalink