website/README.md

Thream/website

⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.

📜 About

Thream's website to stay close with your friends and communities.

It uses Thream/api v1.2.10.

⚙️ Getting Started

Prerequisites

• Node.js >= 16.0.0
• npm >= 8.0.0

Installation

# Clone the repository
git clone git@github.com:Thream/website.git

# Go to the project root
cd website

# Configure environment variables
cp .env.example .env

# Install
npm clean-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://127.0.0.1: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