https://github.com/pedro-estevao/wongames-api
API made with Strapi, to seed the Landing Page NextJS data developed in the React Avançado course.
https://github.com/pedro-estevao/wongames-api
api backend javascript landing-page nodejs react strapi typescript
Last synced: over 1 year ago
JSON representation
API made with Strapi, to seed the Landing Page NextJS data developed in the React Avançado course.
- Host: GitHub
- URL: https://github.com/pedro-estevao/wongames-api
- Owner: Pedro-Estevao
- License: mit
- Created: 2023-08-17T22:43:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T00:20:49.000Z (about 2 years ago)
- Last Synced: 2024-04-13T12:47:07.342Z (about 2 years ago)
- Topics: api, backend, javascript, landing-page, nodejs, react, strapi, typescript
- Language: TypeScript
- Homepage: https://wongames-api.vercel.app
- Size: 331 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# WonGames - Landing Page API
This is the API developed with [Strapi](https://strapi.io) to seed the WonGames landing page for the [React Avançado course](https://reactavancado.com.br/).
## Requirements
This project uses the [MySQL](https://www.mysql.com) database, so to make it work, you need to have it installed on your local machine, or if you prefer, use Docker.
The configuration for the Database can be found in the directory [config/database.js](config/database.js)
## Getting Started
First, run the command to install the dependencies:
```bash
$ npm install
```
Create an `.env` file in the project root, or edit if it already exists, similar to the following structure:
```bash
HOST = 0.0.0.0 #Host where strapi will start
PORT = 1337 #Port where strapi will start
APP_KEYS = "toBeModified1,toBeModified2"
API_TOKEN_SALT = tobemodified
ADMIN_JWT_SECRET = tobemodified
TRANSFER_TOKEN_SALT = tobemodified
JWT_SECRET = tobemodified
# Database
DATABASE_CLIENT = "YOUR_DATABASE_NAME" #Your database name: mysql, postgresql, mariadb (Check the supported databases in the strapi documentation)
DATABASE_HOST = "YOUR_DATABASE_HOST"
DATABASE_PORT = "YOUR_DATABASE_PORT"
DATABASE_NAME = "YOUR_DATABASE_NAME"
DATABASE_USERNAME = "YOUR_DATABASE_USER"
DATABASE_PASSWORD = "YOUR_DATABASE_PASS"
DATABASE_SSL = "YOUR_DATABASE_SSL"
JWT_SECRET = "YOUR_DATABASE_JWT_SECRETE"
```
## Commands
### `dev`
Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-develop)
```bash
$ npm run dev
```
### `start`
Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-start)
```bash
$ npm run start
```
### `build`
Build your admin panel. [Learn more](https://docs.strapi.io/dev-docs/cli#strapi-build)
```bash
$ npm run build
```
## ⚙️ Deployment
Strapi gives you many possible deployment options for your project including [Strapi Cloud](https://cloud.strapi.io). Browse the [deployment section of the documentation](https://docs.strapi.io/dev-docs/deployment) to find the best solution for your use case.