https://github.com/cedrickchee/node-api-kit
Node.js REST API starter kit
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.0%) to scientific vocabulary
Keywords
Repository
Node.js REST API starter kit
Basic Info
- Host: GitHub
- Owner: cedrickchee
- Language: JavaScript
- Default Branch: master
- Homepage: https://ced-nodejs-course-task-mgr.herokuapp.com/
- Size: 333 KB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
Node.js API Starter Kit
A simple starter kit to jumpstart your API services development project.
Demo
Send HTTP requests using cURL or Postman to this API endpoint.
Development
Local Development
- Install MongoDB 4.2+ Community Edition on your OS. Tutorials.
Production Deployment
We are using Heroku for web hosting. So, install and setup Heroku CLI on your OS.
Next, for the database, we will host MongoDB in the Cloud with MongoDB Atlas. Atlas is a managed database-as-a-service on AWS or Google Cloud and born out of mLab. So, go and register an account and set it up by following the instructions there.
Then, run these commands in your terminal:
- Create a new Heroku app
sh
$ heroku create ced-nodejs-course-task-mgr
› Warning: heroku update available from 7.42.0 to 7.42.1.
Creating ⬢ ced-nodejs-course-task-mgr... done
https://ced-nodejs-course-task-mgr.herokuapp.com/ | https://git.heroku.com/ced-nodejs-course-task-mgr.git
- Set Heroku config vars (environment variables)
Replace the following placeholders with your own configuration values.
sh
$ heroku config:set \
JWT_SECRET=<insert your JWT secret>
MONGODB_URL='mongodb+srv://<insert your username>:<insert your password>@cluster0.lzk74.mongodb.net/task-manager-api?retryWrites=true&w=majority' \
SENDGRID_API_KEY=<insert your Sendgrid API key>
-a ced-nodejs-course-task-mgr
Finally, deploy to Heroku.
sh
$ git push heroku master
Owner
- Name: Cedric Chee
- Login: cedrickchee
- Kind: user
- Location: PID 1
- Company: InvictusByte
- Website: https://cedricchee.com
- Twitter: cedric_chee
- Repositories: 227
- Profile: https://github.com/cedrickchee
Lead Software Engineer | LLMs | full stack Go/JS dev, backend | product dev @ startups | 🧑🎓 CompSci | alumni: fast.ai, Antler.co
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0