Campus Website Community

Description

This is a web application that allows users to create communities and share posts with various media types such as images, video, links, poll, voice, etc. The application is built using TypeScript, Chakra UI, Atom, Recoil, and Firebase.

Table of Contents

• Installation
• Usage
• Technology used
• Contributing
• Tests
• License
• Questions

Installation

To run the application locally, follow these steps:

1. Clone the repository to your local machine.
2. Install the dependencies by running npm install in case of dependences updatenpm install --f .
3. Start the development server by running npm run dev.
4. Open http://localhost:3000 in your browser to view the application.
5. don't forget to add the .env.local file in the root directory and paste in the following variables:

NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=

Usage

• Users can create communities with a name, description, and image.
• Users can post various media types such as images, video, links, poll, voice, etc. in their communities.
• The application uses Firebase storage and database to store and retrieve media files and URLs.
• The application is built using modern web technologies such as TypeScript, Chakra UI, Atom, Recoil, and Firebase.

Technologies

• TypeScript
• Chakra UI
• Atom
• Recoil
• Firebase

Contributing

• This project has been think by the club iai dev 2022-2023 and design by myself Gilles Momeni
• The project is open source and every IAI-CAMEROUN student have the right to contribut to it's evolution do your best not to break the system
• If you have a problem contact me for the app references.

License

This project is not yet licensed but will be lather put under the terms of the MIT License.

Questions

If you have any questions, please contact me or visit my GitHub profile.