rONE

It's a university-based social platform. A place for students to share, connect and get guidance with/from peers as well as a place for university professionals to share, promotes university activities.

Table of Contents

• Installation
• Technologies Used
• Project Directory Structure
• Screenshots
• Contributing
• License

Installation

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/kpatel0170/rONE.git

2. Install dependencies for the server:

   cd rONE/server
   npm install

3. Install dependencies for the client:

   cd rONE/client
   npm install

4. Start the server:

   cd ../server
   npm start

5. Start the client:

   cd ../client
   npm start

6. The application should now be running. Open your browser and navigate to http://localhost:3000
7. We have deployed our website on render platform and here is the link: https://one-ebrk.onrender.com/

Technologies Used

The following technologies were used in the development:

• React.Js
• Material UI
• MongoDB
• Node.Js
• Express.Js
• Postman

Project Directory Structure

Below is the directory structure of the project:

├── client/
│       # frontend of the application - UI designs, api integration
├── server/
|        # backend of the application - DB connection, api implementation
├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
└── package.json
 

Screenshots:

HomePage:

Create Post:

Create comment/like/dislike:

View post:

Edit Post:

Delete Post:

Contributing

We welcome contributions to the project. Here's how you can contribute:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b new-feature.
3. Make the necessary code changes.
4. Test your changes.
5. Commit your changes with descriptive commit messages: git commit -m "Add new feature".
6. Push your changes to your forked repository: git push origin new-feature.
7. Open a pull request with a clear description of your changes.
8. Address any feedback or comments during the review process.
9. Once approved, your contribution will be merged into the project.

Please follow these guidelines to ensure a smooth contribution process. Thank you for your interest in contributing!

License

This project is licensed under the MIT License - see the LICENSE.md file for details.