mirror of
https://github.com/Thream/api.git
synced 2024-07-21 03:38:31 +02:00
87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
|
<h1 align="center"><a href="https://api.thream.divlo.fr/docs">Thream/api</a></h1>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<strong>Thream's application programming interface to stay close with your friends and communities.</strong>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
|
||
|
|
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
|
||
|
|
<a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
|
||
|
|
<br />
|
||
|
|
<a href="https://github.com/Thream/api/actions/workflows/analyze.yml"><img src="https://github.com/Thream/api/actions/workflows/analyze.yml/badge.svg?branch=develop" /></a>
|
||
|
|
<a href="https://github.com/Thream/api/actions/workflows/build.yml"><img src="https://github.com/Thream/api/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
|
||
|
|
<a href="https://github.com/Thream/api/actions/workflows/lint.yml"><img src="https://github.com/Thream/api/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
|
||
|
|
<a href="https://github.com/Thream/api/actions/workflows/test.yml"><img src="https://github.com/Thream/api/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
|
||
|
|
<br />
|
||
|
|
<a href="https://www.npmjs.com/package/ts-standard"><img alt="TypeScript Standard Style" src="https://camo.githubusercontent.com/f87caadb70f384c0361ec72ccf07714ef69a5c0a/68747470733a2f2f62616467656e2e6e65742f62616467652f636f64652532307374796c652f74732d7374616e646172642f626c75653f69636f6e3d74797065736372697074"/></a>
|
||
|
|
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
|
||
|
|
<a href="https://dependabot.com/"><img src="https://badgen.net/github/dependabot/Thream/api?icon=dependabot" alt="Dependabot badge" /></a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
## 📜 About
|
||
|
|
|
||
|
|
Thream's application programming interface to stay close with your friends and communities.
|
||
|
|
|
||
|
|
This project was bootstrapped with [create-fullstack-app](https://github.com/Divlo/create-fullstack-app).
|
||
|
|
|
||
|
|
## ⚙️ Getting Started
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
- [Node.js](https://nodejs.org/) >= 14
|
||
|
|
- [npm](https://www.npmjs.com/) >= 6
|
||
|
|
- [MySQL](https://www.mysql.com/) >= 8
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# 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](https://www.docker.com/)
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Setup and run all the services for you
|
||
|
|
docker-compose up
|
||
|
|
```
|
||
|
|
|
||
|
|
### Production environment with [Docker](https://www.docker.com/)
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Setup and run all the services for you
|
||
|
|
docker-compose --file=docker-compose.production.yml up
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Services started
|
||
|
|
|
||
|
|
- API : `http://localhost:8080`
|
||
|
|
- [MySQL database](https://www.mysql.com/)
|
||
|
|
|
||
|
|
#### Services started only in Development environment
|
||
|
|
|
||
|
|
- [phpmyadmin](https://www.phpmyadmin.net/) : `http://localhost:8000`
|
||
|
|
- [MailDev](https://maildev.github.io/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](./CONTRIBUTING.md) file.
|
||
|
|
|
||
|
|
## 📄 License
|
||
|
|
|
||
|
|
[MIT](./LICENSE)
|