2
2
mirror of https://github.com/Thream/website.git synced 2024-07-21 09:28:32 +02:00
website/README.md
Divlo a0fa66e8f5
feat: design applications and first api calls
Co-authored-by: Walid <87608619+WalidKorchi@users.noreply.github.com>
2021-10-24 06:09:43 +02:00

2.9 KiB

Thream/website

Licence MIT Contributor Covenant

Conventional Commits semantic-release Dependabot badge

📜 About

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

This project was bootstrapped with create-fullstack-app.

Using Thream/api v1.0.0.

⚙️ 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