📢 Join Discord channel for Discussion about the project : Athavani

📌 Motive of the Project

Athavani or Memories is a full-stack MERN tool built in order to save all your memories in a single place and rejoice them through the year.

💡 Project Background

The Project is built with the help of Reactjs and Material-Ui at Frontend and backed by Nodejs and Expressjs at Backend using MongoDB as a Database. The user has the following ability

Create a Memory
Update a Memory
Delete a Memory
Like a Particular Memory
Fetch all Memory at a Time

Technologies Used

A sneek peek into what we have here🙈 :

Creation of Memory

Updation of Memory

Like a Memory

Delete a Memory

⭐ Getting Started

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

💥 A guide for Contribution

Take a look at the Existing Issues or create your own Issues!
Wait for the Issue to be assigned to you after which you can start working on it.
Fork the Repo and create a Branch for any Issue that you are working upon.
Read the Code of Conduct
Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
Add Screenshots to help us know what this Script is all about.
For more details visit the Contribution Guide

⭐ Contribution:

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/Athavani

3. Navigate to the project directory.

cd Athavani

4. Make changes in source code.

5. Stage your changes and commit

#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"

7. Push your local commits to the remote repo.

git push

8. Create a PR !

9. Congratulations! Sit and relax, you've made your contribution to Athavani project.

▶️ How to Run the Project

1. Navigate to the project directory.

cd Athavani

2. Navigate to the Client directory.

cd Client
npm install
npm start / yarn start

3. Navigate to the Server directory.

cd Athavani
npm install
npm start

⭐ Issues:

For major changes, you are welcomed to open an issue and discuss what you would like to contribute. Enhancements will be appreciated.

🔔 Credits

The project is built by learning from JavaScript Mastery and various resource available on the internet.

shrushti2000/Athavani