This repository has been archived on 2024-10-29. You can view files and clone it, but cannot push or open issues or pull requests.
website/README.md
2022-05-12 20:35:46 +02:00

2.7 KiB

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 v1.0.1.

⚙️ Getting Started

Prerequisites

Installation

# 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

npm run dev

Production environment with Docker

# 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.

📄 License

MIT