https://github.com/vectormike/fantastic-palm-tree
https://github.com/vectormike/fantastic-palm-tree
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vectormike/fantastic-palm-tree
- Owner: Vectormike
- Created: 2022-11-17T10:16:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T10:47:18.000Z (over 3 years ago)
- Last Synced: 2025-02-02T06:41:28.502Z (over 1 year ago)
- Language: TypeScript
- Size: 80.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bananpie Development Test
## Manual Installation
Clone the repo:
```bash
git clone https://github.com/Vectormike/fantastic-palm-tree bananapie
cd bananapie
```
Install the dependencies:
```bash
npm install
```
Set the environment variables:
```bash
cp .env.example .env
# open .env and modify the environment variables (if needed)
```
## Commands
Running locally:
```bash
npm run dev
```
Build:
```bash
npm run build
```
Running in production:
```bash
npm start
```
## Environment Variables
The environment variables can be found and modified in the `.env` file. They come with these default values:
```bash
# Port number
PORT=3000
# URL of the Mongo DB
# MONGODB_URL=mongodb://127.0.0.1:27017/bananapie
```
## API Documentation
To view the list of available APIs and their specifications, go to `https://documenter.getpostman.com/view/5622145/2s8YmNPhh5#c2c90834-657e-4d04-853d-d1778d966671` in your browser.