📢 Join Slack channel for Discussion about the project : CollegeAada

📌 Motive of the Project

CollegeAda is a full-stack MERN tool built which is a unified platform which connects seniors and juniors at a single place allowing the seniors to share books, question paper, notes, blogs and guidance which will help students and is the need of the hour

💡 Project Background

The Project is built will be build 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

• Signup as a senior,junior
• Share/Lend Books
• Upload Stationary items like Workshop Aapron, costly ED stationaries
• Post Solution/Queries to solve problem of juniors
• Gives Well Writen Notes and Question Paper
• Community Blogs/Chat feature

⭐ 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:

• Watch this video to get started, if you have no clue about open source
• Forking a Repo
• Cloning a Repo
• How to create a Pull Request
• Getting started with Git and GitHub

💥 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>/CollegeAada

3. Navigate to the project directory.

cd CollegeAada

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 CollegeAada project.

▶️ How to Run the Project

1. Navigate to the project directory.

cd CollegeAada

2. Navigate to the Client directory.

cd client
npm install
npm start / yarn start

3. Navigate to the Server directory.

cd server
npm install
npm start 

🛈IMPORTANT🛈

To open the webapp directly from CLI use:- explorer "https://memoriestejastapas.netlify.app/"

if you have cloned this repo, then open git in this directory and use ./script.sh

📢 Open Source Program

This Project is a part of the following Open Source Program

⭐ Issues:

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

❤️ Project Admin

Tejas1510 💻