it-project-team-34

Running

To start up all aspects of this software, run

npm run start

Front End

To start up the front end react app, run

npm run front

Back End

First create a file called .env in the back_end directory where the mongodb url is stored. This can be done by running

touch back_end/.env && echo "DATABASE_URL=<insert_mongodb_url>" > back_end/.env && echo "BACK_END_LISTENING_PORT=3000" >> back_end/.env

where <insert_mongodb_url> denotes the mongodb url. This only needs to be done the first time setting up this server.

Run the server by running

npm run back

Guide to NPM (Temp) and How Things Were Set Up

In the root directory I ran npm init which produced the package.json file. In that file there is a key called "scripts" which has an object, as a value, of commands to run. For example right now there is a command denoted by the key "back" which starts the back end server by changing into the back_end directory and calls npm to start the server. To call these commands, you may run npm run <key of script>. E.g. npm run back.

I similarly ran npm init to set up the back_end npm environment in the back_end directory. It similarly has a package.json file that has the "scripts" key, holding the scripts that may be ran with npm run <key of script>. For the front end, however, the environment and package.json file was set up by calling npx create-web-app which basically just adds on to the articles produced by npm init by adding react specific artefacts.

To specify dependencies that your software needs for it to be ran, you can use npm install <dependency> or npm i <dependency>. For example I used npm i express and npm i mongoose. This will also note down the dependencies under the "dependencies" key in the package.json file. If there are dependencies needed just for development purposes, you can add the --save-dev flag. E.g.npm i typescript --save-dev. You can see those dependencies under "devDependencies" in the package.json.

You front-enders will need to work out what dependencies are needed for your React app!

TODO

• Set up a directory for the mobile app.