Skip to content

Commit d5805ea

Browse files
authored
Update README.md
1 parent a962d8f commit d5805ea

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
# Idaka
2+
Download and compile Idaka following the steps.
23

3-
Download and compile Idaka with the following commands.
4+
### 1. Configure the database with MongoDB Atlas
5+
#### Create the database
6+
To create a MongoDB use the following link to go to the home page https://account.mongodb.com/account/login where you can find the database section. Here you need to click on the create button.
7+
8+
![Imagen1](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/7487dc54-4904-43db-8ad3-5f16fc1ad2f0)
9+
![image](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/233f2d68-c391-454f-860a-f5df1d57764a)
10+
11+
For more details please refer to [MongoDB_Documentation](https://www.mongodb.com/basics/create-database)
12+
#### Create the collections on the created database
13+
Once you create the database, you need to create the collections that the app uses. For this you need to navigate to the Collections tab and click on the plus sign + icon for a database
14+
15+
Then you need to enter the Collection Name, in this case we need 4 collections: Practices, Queries, Stages, TasksWithPractices.
16+
![image](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/dede5ab5-6ee4-4cfa-939f-61335668728f)
17+
![image](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/fc2e5a1f-89c9-4f88-bf63-b7928b16a947)
18+
19+
For more details please refer to [MongoDB_Documentation](https://www.mongodb.com/docs/atlas/atlas-ui/collections/)
20+
#### Upload data
21+
The following data needs to be uploaded on their corresponding collections:
22+
* [Practices](Practices.json)
23+
* [Stages]()
24+
* [TasksWithPractices]()
25+
26+
In order to do this you should go to your collection and click on Insert Document. Select the JSON way to upoad data and copy and paste the corresponding data.
27+
![image](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/30ccc6b1-faf0-48d0-8320-a115afd9401d)
28+
![image](https://github.com/TheSoftwareDesignLab/Idaka/assets/60227230/e368b16b-2d13-4e66-bf44-9efe37b04052)
29+
30+
31+
### 2. Configure the environment variables
32+
On the back-end folder create a .env file with the variable REACT_APP_DB_CONNECTION_STRING. Note that you should add the connection string for your database.
33+
For more details please refer to [MongoDB_Documentation](https://www.mongodb.com/basics/mongodb-connection-string#:~:text=In%20the%20MongoDB%20Atlas%20web,connection%20string%20for%20your%20cluster.)
34+
35+
36+
### 3. Download and compile Idaka with the following commands.
437
```
538
git clone https://github.com/TheSoftwareDesignLab/Idaka.git
639
```

0 commit comments

Comments
 (0)