Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kr/update readme #10

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# covidhelphub-backend

# Description:

Backend for the backend of the org app for Reach4Help
## Getting Started

### To start:
### Dependencies
1. Copy .env.integration to .env
* Before we forget! Create a new `.env` file in your root folder with the same content as our [integration](/.env.integration) file. This will be used by our integration tests once we have them.
1. Install Docker
* Because our backend needs to connect to stuff like a database, etc. You need to install [docker](https://www.docker.com/get-started) in order to start the project.
1. Install Docker Compose
* If you're using Mac or Windows you should be good to go, however, if you are using Linux, you must install [Docker Compose](https://docs.docker.com/compose/install/) (already included in the versions for Mac and Windows), a command line tool that builds on top of the Docker Engine and provides a series of useful commands that we are going to be using to start our project.
1. Run Docker

- Before we forget! Create a new `.env` file in your root folder with the same content as our [integration](/.env.integration) file. This will be used by our integration tests once we have them.
- Because our backend needs to connect to stuff like a database, etc. You need to install [docker](https://www.docker.com/get-started) in order to start the project.
- If you're using Mac or Windows you should be good to go, however, if you are using Linux, you must install [Docker Compose](https://docs.docker.com/compose/install/) (already included in the versions for Mac and Windows), a command line tool that builds on top of the Docker Engine and provides a series of useful commands that we are going to be using to start our project.
- After the previous steps you should be able to run `npm start`, which in turn runs a simple [script](/scripts/start.sh) that aims to make this start up very easy to do.
- You can check we have two Dockerfiles that describe our service (`Dockerfile` and `Dockerfile.dev`). Our `start` is using `Dockerfile.dev` which supports hot reload and all that good stuff so we can develop with pleasure!
### Running the application
1. Run `npm start`
* After the previous steps you should be able to run `npm start`, which in turn runs a simple [script](/scripts/start.sh) that aims to make this start up very easy to do.
* You can check we have two Dockerfiles that describe our service (`Dockerfile` and `Dockerfile.dev`). Our `start` is using `Dockerfile.dev` which supports hot reload and all that good stuff so we can develop with pleasure!

When the server starts have a go with the GraphQL playground at:

Expand Down