https://github.com/zgramming/phincon-pokemon-be
https://github.com/zgramming/phincon-pokemon-be
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zgramming/phincon-pokemon-be
- Owner: zgramming
- Created: 2024-04-25T13:47:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T05:32:21.000Z (about 2 years ago)
- Last Synced: 2024-12-27T06:10:20.256Z (over 1 year ago)
- Language: TypeScript
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
Awesome Lists containing this project
README
# RESTful API Node Express
The project builds RESTful APIs using Node.js, Express for PokeAPI
## Manual Installation
```bash
git clone https://github.com/zgramming/phincon-pokemon-be.git
cd phincon-pokemon-be
```
Install the dependencies:
```bash
npm install
```
## Table of Contents
- [Commands](#commands)
- [Environment Variables](#environment-variables)
- [API Endpoints](#api-endpoints)
## Commands
Running in development:
```bash
npm run dev
```
Running in production:
```bash
# build
npm run build
# start
npm run start
```
### API Endpoints
List of available routes:
**Pokemon**:\
`POST api/v1/pokemon/catch/:name` - Catch Pokemon\
`PUT api/v1/pokemon/rename/:name` - Rename Pokemon\
`DEL api/v1/pokemon/release/:name` - Release Pokemon