https://github.com/vectormike/special-fiesta
https://github.com/vectormike/special-fiesta
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vectormike/special-fiesta
- Owner: Vectormike
- Created: 2022-11-08T13:45:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-16T07:43:40.000Z (over 3 years ago)
- Last Synced: 2025-06-10T13:05:09.010Z (12 months ago)
- Language: JavaScript
- Size: 283 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spiralyze Development Test
## Manual Installation
Clone the repo:
```bash
git clone https://github.com/ spiralyze
cd spiralyze
```
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
```
Running in production:
```bash
npm start
```
Testing:
```bash
# run all tests
npm test
# run all tests in watch mode
npm test:watch
```
## 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/spiralyze
```
## API Documentation
To view the list of available APIs and their specifications, go to `https://documenter.getpostman.com/view/5622145/2s8YYPHfsA` in your browser.