Thream/website

Licence MIT Contributor Covenant

Conventional Commits semantic-release

## 📜 About Thream's website to stay close with your friends and communities. It uses [Thream/api](https://github.com/Thream/api) v1.0.0. ## ⚙️ Getting Started ### Prerequisites - [Node.js](https://nodejs.org/) >= 16.0.0 - [npm](https://www.npmjs.com/) >= 8.0.0 ### Installation ```sh # Clone the repository git clone https://github.com/Thream/website.git # Go to the project root cd website # Configure environment variables cp .env.example .env # Install npm install ``` You will need to configure the environment variables by creating an `.env` file at the root of the project (see `.env.example`). ### Local Development environment ```sh npm run dev ``` ### Production environment with [Docker](https://www.docker.com/) ```sh # Setup and run all the services for you docker-compose up --build ``` #### Services started - website : `http://localhost:3000` ## 💡 Contributing Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake. The steps to contribute can be found in [CONTRIBUTING.md](./CONTRIBUTING.md). ## 📄 License [MIT](./LICENSE)