christophe-riolo/api

Thream's application programming interface to stay close with your friends and communities.

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.

See Thream/website for visual overview of the features of the project.

This project was bootstrapped with create-fullstack-app.

⚙️ Getting Started

Prerequisites

• Node.js >= 14
• npm >= 6
• MySQL >= 5.7

Installation

# Clone the repository
git clone https://github.com/Thream/api.git

# Go to the project root
cd api

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

Usage (development environment)

With docker

# Setup and run all the services for you
docker-compose up --build

Services started :

• API : http://localhost:8080
• phpmyadmin : http://localhost:8000
• MailDev : http://localhost:1080
• MySQL database (with PORT 3006)

Without docker

# Start the API server (http://localhost:8080)
npm run dev

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

📄 License

MIT