Skip to content

Commit 046c422

Browse files
chore-#141: Updated Documentation (#428)
2 parents 954593b + ec2de89 commit 046c422

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

Diff for: .github/CONTRIBUTING.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,19 @@ To setup the project locally follow the steps:
4040
1. Fork and Star the project.
4141
2. Clone your forked repository.
4242
3. Run `npm run installer`.
43-
4. Set up your MongoDB database:
44-
- Open MongoDB Compass and run MongoDB locally at `mongodb://localhost:27017`.
45-
- Import sample posts data from `backend/data/sample_posts.json`.
46-
5. Rename the `.env.sample` file in the backend and frontend folders to `.env`.
47-
6. Launch the development server with `npm start` in the root directory of the repository.
43+
4. Set up your databases
44+
- Make sure you [install mongodb](https://www.mongodb.com/docs/manual/installation/) and run it in `mongodb://localhost:27017`
45+
```bash
46+
# To populate the database with sample posts, you can copy the content from the `backend/data/sample_posts.json` file and
47+
# insert it as a document in the `wanderlust/posts` collection in your local MongoDB database using either MongoDB Compass or `mongoimport`.
48+
mongoimport --db wanderlust --collection posts --file ./data/sample_posts.json --jsonArray
49+
```
50+
- Make sure you [install redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) and run it in `redis://127.0.0.1:6379`
51+
5. Set up env variables
52+
- ```sh
53+
cp backend/.env.sample backend/.env && cp frontend/.env.sample frontend/.env.local
54+
```
55+
7. Launch the development server with `npm start` in the root directory of the repository.
4856

4957
<a name="request-for-changes-pull-requests"></a>
5058

@@ -109,7 +117,6 @@ To contribute to this project, you need to create a fork of the repository and t
109117
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the Wanderlust repository](https://github.com/krishnaacharyaa/wanderlust) following the template provided.
110118
111119
<a name="guidelines-to-follow"></a>
112-
Sure, let's refine the guidelines while keeping them clear and straightforward:
113120
114121
## Guidelines for Contributions
115122

0 commit comments

Comments
 (0)