Skip to content
Snippets Groups Projects
Commit f7a5501b authored by Stephanie Briere Americo's avatar Stephanie Briere Americo
Browse files

Merge branch 'issue/58' into 'develop'

Issue #58: Update README.md

Closes #58

See merge request !67
parents 4ccc1cee c279f20d
No related branches found
No related tags found
1 merge request!67Issue #58: Update README.md
Pipeline #22877 passed
...@@ -4,6 +4,25 @@ ...@@ -4,6 +4,25 @@
RESTful API used to manage and answer forms. RESTful API used to manage and answer forms.
Backend installation instructions:
- Be sure your system is 64-bits or Docker will not work.
- Git clone this repo, doesn't matter if it's done with SSH or HTTPS.
- Use $~ git submodule update --init --recursive command to pull the database submodule inside the project.
- Use $~ sudo apt install docker.io command to install Docker.
- Use $~ sudo apt install docker-compose command to install docker-compose.
- Use $~ mv .env.example .env command to set the env file.
- Use $~ cd config/ command and then $~ mv config.env.example config.env commando to set config env.
- Use $~ cp config.env test.env to copy the env to the test env.
- Use $~ vim(vi) test.env and change the port to 3001, for example (optional so tests don't break).
- Use $~ sudo docker-compose up --build to run docker.
- If everything worked out good there'll be a message "server listening on port 3000".
- Open a new terminal, go to the form-creator-api directory and execute $~ sudo docker exec -it formcreatorapi_form-creator-api-backend_1 bash.
- Now, inside this backend docker, run $~ yarn run test.
- Use $~ sudo docker exec -it form-postgres bash, then type psql -U postgres on this docker that just opened.
- You are, now, inside postgreSQL, you can use \dt command to list all tables, be sure you have 13.
- That's it, backend installed.
## Objective ## Objective
The main objective of this project is create a *Web Service* which allows users The main objective of this project is create a *Web Service* which allows users
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment