git clone https://github.com/alhabibhasan/argupedia-backend.git
cd argupedia-backend; npm install; npm start
If you've already set up the firebase instance by following the steps from the README of the front end app, then you can skip these set up steps for Firebase auth and DB set up, as we only need the one instance of firebase. This means that you can use the same credentials for the front end and back end app.
You will need to set up and connect to your own instance of firebase. Steps to do this can be found here: https://firebase.google.com/
You will need to add the credentials into the admin/firebase/auth/firebase.js file.
Your firebase instance will need to have auth and realtime DB enabled.
We require at least email and password and Google authentication to be enabled via the Firebase Auth panel.
Please ensure this has been setup. You can find steps here: https://firebase.google.com/docs/auth/web/password-auth. This link will show you how to enable email and password auth, it will contain links to enabling Google authentication as well.
You must also set up a realtime Database instance. Steps to create your own firebase realtime database instance can be found here: https://firebase.google.com/docs/database/web/start
Only add data to the realtime DB via the Admin panel accessed via the back end app. This will mean that the react app will be able to read the data in the correct way.
In order to use the app, you will need to download and install a Neo4j database instance onto your machine.
You can find instructions on how to do this here: https://neo4j.com/docs/operations-manual/current/installation/
Once you have install Neo4j onto your machine, you will need to create a new graph instance. This can be done via the Neo4j Desktop browser.
After you do this, please update/create the .env with the specific details of your database graph. The .env file must be placed in the root directory of the project.
This will allow Argupedia to connect to the database.
Argupedia will handle the structure of the data within the graph itself.
In order to run tests, you will need to ensure that you have set up a separate test database graph. You can do this by repeating the steps from the previous step and setting the values within the .env.test.
Once you have created database graph and have updated/created the .env.test file (also in the root directory), close all active instances of the app. Then run:
npm test
This will run tests and generate code coverage documentation. This can be found and explored by opening the coverage/index.html in a browser window.