pub-solar/obs-portal
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Update README for recursive cloning

Browse source
This commit is contained in:
Paul Bienkowski 2021-05-12 19:20:06 +02:00
parent 3d8238307a
commit 8612bb08a6
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -16,6 +16,10 @@ First of all, you must clone this project. This project uses submodules,
thus ensure, that they are cloned as well: thus ensure, that they are cloned as well:
```bash ```bash
git clone --recursive https://github.com/openbikesensor/portal
# ... or if you forgot the --recursive argument, you can run this in the
# repository's directory later:
git submodule update --init --recursive git submodule update --init --recursive
``` ```
@ -28,7 +32,7 @@ make sure to properly set up and secure your server yourself.
1. Create a user for running the application. It is not recommended to run as a 1. Create a user for running the application. It is not recommended to run as a
user that is also used for other things. Do not run as root! user that is also used for other things. Do not run as root!
2. Clone the repository. 2. Clone the repository.
3. Install `node` of at least version 15, and also `npm`. You can use the 3. Install `node` of at least version 15, and also `npm`. You can use the
[Node Version Manager (nvm)](https://github.com/nvm-sh/nvm), since this project [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm), since this project
contains a `.nvmrc`. Just run `nvm install` followed by `nvm use`. contains a `.nvmrc`. Just run `nvm install` followed by `nvm use`.
4. Run `npm ci` in the `api` and `frontend` directories to install dependencies. 4. Run `npm ci` in the `api` and `frontend` directories to install dependencies.
@ -120,13 +124,13 @@ docker-compose run --rm api npm run migrate:up
```` ````
## Custom MongoDB installation ## Custom MongoDB installation
If you have your own MongoDB instance running somewhere, you can set the If you have your own MongoDB instance running somewhere, you can set the
environment variable `MONGODB_URL` when starting the server, and it will read environment variable `MONGODB_URL` when starting the server, and it will read
that URL for connecting. that URL for connecting.
export MONGODB_URL=mongodb://user:password@mongodb.example.com/obs-app-database export MONGODB_URL=mongodb://user:password@mongodb.example.com/obs-app-database
This does not work when using docker-compose, in that case, you will have to This does not work when using docker-compose, in that case, you will have to
modify the `docker-compose.yaml` to include that URL. modify the `docker-compose.yaml` to include that URL.
@ -140,7 +144,7 @@ you start the application like so: `npm run dev -- --devSendMails`.
Mails are also always sent in production mode! Mails are also always sent in production mode!
For actually sending e-mails the mailserver, sender, user and password for the For actually sending e-mails the mailserver, sender, user and password for the
SMTP server need to be specified as environment variables: SMTP server need to be specified as environment variables:
* `MAILUSER` -- the smtp mailbox login name * `MAILUSER` -- the smtp mailbox login name
* `MAILPW` -- password for the mailbox * `MAILPW` -- password for the mailbox