README.md

newsletter-api

📰 a lightweight newsletter backend server used by the zicli site

🔧 Installation

# clone repo and navigate into directory
git clone https://github.com/zicli/newsletter-api.git && cd newsletter-api

# make sure you have nvm installed to a stable version 
nvm install

# install dependencies
npm i

# edit .env file to right parameters (See .env.sample)
# run development server @localhost:3000
npm run start:dev

🔬 Testing

# run application tests
npm run test

Api routes can also be tested on postman, or graphql dedicated test suite

# run development server
npm run start:dev

# open browser and navigate to localhost:3000/graphql
# run graphql queries.
# check docs folder for query examples

📚 Documentation

• Architecture
• API Documentation