Clone the repo:
git clone https://github.com/Drex72/Open-Wallet-Api
cd Open-Wallet-Api
Install the dependencies:
npm install
Create an Account at Fixer.Io and Get an API Key to add to your env Fixer IO Website
Set the environment variables:
cp .env.example .env
# open .env and modify the environment variables (if needed)
Running locally:
npm run dev
The environment variables can be found and modified in the .env
file. They come with these default values:
#Server environment
NODE_ENV=development
#Port number
PORT=6000
#Db configuration
DB_NAME=db-name
DB_USERNAME=db-usernmae
DB_HOST=db-host
DB_PASSWORD=db-password
# Access Token and Refresh Token Configuration
ACCESS_TOKEN_SECRET=access-token-secret
REFRESH_TOKEN_SECRET=refresh-token-secret
# Fixer Io Configuration
FIXER_IO_API_KEY=fixer-io-api-secret
specs\
src\
|--config\ # Environment variables and configuration related things
|--controllers\ # Route controllers (controller layer)
|--exceptions\ # Error Exceptions
|--handlers\ # Handlers for various things
|--models\ # Sequelize models (data layer)
|--routes\ # Routes
|--services\ # Business logic (service layer)
|--utils\ # Helper classes and functions
|--validators\ # Request data validation schemas
|--index.ts # App entry point