README.md

RSR is a school project, in which we managed to build up communities and make them share ressources.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project

   </li>
   <li>
     <a href="#getting-started">Getting Started</a>
     <ul>
       <li><a href="#installation">Installation</a></li>
     </ul>
   </li>
   <li><a href="#roadmap">Roadmap</a></li>
   <li><a href="#contributing">Contributing</a></li>
   <li><a href="#license">License</a></li>
   

About The Project

Enter a chat room, discuss, exchange, share your ideas, your experiences, your projects, your thoughts. Forge links between you and each citizen thanks to the resources you will find on the site.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/floriaaan/rsr-web.git

2. Compose Docker containers

   docker compose up

3. Build app

   npm run build

(back to top)

Roadmap

• No more features since development is over

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'feat: add amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL 3.0 License. See LICENSE for more information.

(back to top)