mirror of
https://github.com/Thream/api.git
synced 2024-07-06 21:00:11 +02:00
Thream's Application Programming Interface (API) to stay close with your friends and communities.
https://api.thream.divlo.fr/documentation
| .github | ||
| .husky | ||
| src | ||
| uploads | ||
| .commitlintrc.json | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .gitignore | ||
| .markdownlint.json | ||
| .npmrc | ||
| CONTRIBUTING.md | ||
| docker-compose.production.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Dockerfile.production | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Thream/api
Thream's application programming interface to stay close with your friends and communities.
📜 About
Thream's application programming interface to stay close with your friends and communities.
This project was bootstrapped with create-fullstack-app.
⚙️ Getting Started
Prerequisites
Installation
# Clone the repository
git clone https://github.com/Thream/api.git
# Go to the project root
cd api
# Configure environment variables
cp .env.example .env
# Install dependencies
npm install
You will need to configure the environment variables by creating an .env file at the root of the project (see .env.example).
Development environment with Docker
# Setup and run all the services for you
docker-compose up
Production environment with Docker
# Setup and run all the services for you
docker-compose --file=docker-compose.production.yml up
Services started
- API :
http://localhost:8080 - MySQL database
Services started only in Development environment
- phpmyadmin :
http://localhost:8000 - MailDev :
http://localhost:1080
💡 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 the CONTRIBUTING.md file.