JKomieter / CampusCommune

CampusCommune

https://campus-commune.vercel.app/

Welcome to the Campus Commune app! This documentation provides an overview of the app's features, installation instructions, and guidelines for contributing.

Table of Contents

• Features
• Installation
• Usage
• Contributing
• License

Features

Campus Commune is a platform designed for students to connect, collaborate, and share their thoughts. Some of its key features include:

• Discussion Boards: Create and join discussions on various topics.
• Real-time Messaging: Chat with other students in your discussions.
• User Profiles: Customize your profile and add a profile picture.
• Notifications: Stay updated with notifications for new discussions and messages.

Installation

Follow these steps to set up the Campus Commune app locally:

1. Clone the repository:

   git clone https://github.com/your-username/campus-commune.git

2. Navigate to the project directory:

   cd campus-commune

3. Install the dependencies:

   npm install

4. Configure Firebase:

   • Create a Firebase project.
   • Set up Firebase Authentication, Firestore, and Realtime Database.
   • Add your Firebase configuration in the app.

5. Start the development server:

   npm start

6. Access the app at http://localhost:3000 in your web browser.

Usage

1. Sign up for an account or log in if you already have one.
2. Explore existing discussions or create a new one.
3. Join discussions, share your thoughts, and chat with other students.
4. Customize your profile with a profile picture and a bio.
5. Receive notifications for new messages and discussions.

Contributing

We welcome contributions from the community. To contribute to Campus Commune, follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository locally.
3. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature

4. Make your changes and commit them:

   git commit -m "Add your commit message here"

5. Push your changes to your forked repository:

   git push origin feature/your-feature

6. Create a pull request on the main repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.