FontTechFont Tech - Basic nodejs project skeleton
______ ____ _ _ _______ _ _
| ____| / __ \ | \ | | |__ __| | | | |
| |__ | | | | | \| | | | | |_ ___ ___ | |__
| __| | | | | | . ` | | | | __| / _ \ / __| | '_ \
| | | |__| | | |\ | | | | |_ | __/ | (__ | | | |
|_| \____/ |_| \_| |_| \__| \___| \___| |_| |_|Getting started
This is a basic API REST skeleton written on JavaScript using async/await. Great for building a starter web API for your front-end (Android, iOS, Vue, react, angular, or anything that can consume an API)
This project is created to help other developers create a basic REST API in an easy way with Node.js. This basic example shows how powerful and simple JavaScript can be. Do you want to contribute? Pull requests are always welcome to show more features.
Features
- Multiple environment ready (development, production)
- Custom email/password user system with basic security and blocking for preventing brute force attacks.
- Compressed responses.
- Secured HTTP headers.
- CORS ready.
- Cache ready (Redis).
- HTTP request logger in development mode.
- i18n ready (for sending emails in multiple languages).
- User roles.
- Pagination ready.
- User profile.
- Users list for admin area.
- Cities model and controller example.
- Login access log with IP, browser and country location (for country it looks for the header
cf-ipcountrythat CloudFlare creates when protecting your website). - API autogenerated documentation by Postman.
- API collection example for Postman.
- Testing with mocha/chai for API endpoints.
- NPM scripts for cleaning and seeding the MongoDB database.
- NPM script for keeping good source code formatting using prettier and ESLint.
- Use of ESLint for good coding practices.
- Mailer example with Nodemailer and Mailgun.
- Ability to refresh token
- JWT Tokens, make requests with a token after login with
Authorizationheader with valueBearer yourTokenwhereyourTokenis the signed and encrypted token given in the response from the login process.
Requirements
- Node.js 8+
- MongoDB 3.6+
- Redis 5.0+
Login credentials
email: `admin@admin.compassword:12345`
How to install
Using Git (recommended)
- Clone the project from github. Change "myproject" to your project name.
git clone https://gitlab.com/fontalland/fontbaseserver.git ./fontbaseserverUsing manual download ZIP
- Download repository
- Uncompress to your desired directory
Install npm dependencies after installing (Git or manual download)
cd myproject
npm install
npm updateSetting up environments (development or production)
- In the root this repository you will find a file named
.env.example - Create a new file by copying and pasting the file and then renaming it to just
.env - The file
.envis already ignored, so you never commit your credentials. - Change the values of the file to your environment (development or production)
- Upload the
.envto your environment server(development or production) - If you use the postman collection to try the endpoints, change value of the variable
serveron your environment to the url of your server, for development mode use http://localhost:3000
IMPORTANT: By default token expires in 3 days (4320 minutes set in .env.example). You can refresh token at endpoint GET /token. If everything it´s ok you will get a new token.
Mailer
To ensure the deliverability of emails sent by this API, Mailgun is used for mailing users when they sign up, so if you want to use that feature go sign up at their website https://www.mailgun.com
If you want to try a different method it´s ok, I used https://nodemailer.com for this API and they have different transport methods like: smtp.
i18n
Language is automatically detected from Accept-Language header on the request. So either you send locale manually on the request or your browser will send its default, if Accept-Language header is not sent then it will use en locale as default.
How to run
Database cleaning and seeding samples
There are 3 available commands for this: fresh, clean and seed.
npm run commandfreshcleans and then seeds the database with dynamic data.cleancleans the database.seedseeds the database with dynamic data.
Running in development mode (lifting API server)
npm run devYou will know server is running by checking the output of the command npm run dev
****************************
* Starting Server
* Port: 3000
* NODE_ENV: development
* Database: MongoDB
* DB Connection: OK
****************************Running tests
It´s a good practice to do tests at your code, so a sample of how to do that in mocha/chai is also included in the /test directory
npm run testFormatting code
Format your code with prettier by typing:
npm run formatFormatting markdown files
Format all your markdown files with remark by typing:
npm run remarkLinting code
Lint your code with ESLint by typing:
npm run lintUsage
Once everything is set up to test API routes either use Postman or any other api testing application. Default username/password combination for login is `admin@admin.com/12345`.
API documentation
https://documenter.getpostman.com/view/487539/RWaHwoLV
Postman API example collection
You can import the example collection to Postman. To import, click the import button located and select postman-example.json located within the root directory.
Go to manage environments to create environments for development, production, etc. On each of the environments you create you will need to:
Create a new key
authTokenand within the/loginrequest this value is automatically updated after a successfull login through a script located in theteststab. Each time you make a request to the API it will sendAuthorizationheader with thetokenvalue in the request, you can check this on the headers of users or cities endpoints in the Postman example.Create a second key
serverwith the url of your server, for development mode use http://localhost:3000
This is a REST API, so it works using the following HTTP methods:
- GET (Read): Gets a list of items, or a single item
- POST (Create): Creates an item
- PATCH (Update): Updates an item
- DELETE: Deletes an item
Creating new models
If you need to add more models to the project just create a new file in /app/models/ and it will be loaded dynamically.
Creating new routes
If you need to add more routes to the project just create a new file in /app/routes/ and it will be loaded dynamically.
Creating new controllers
When you create a new controller file, try to also create another file with validations. Ex. countries.js and countries.validate.js. An example of this is included in the repository.
Developer Informations
Server init
- To a fast server initialization
./init-server.sh
Mongo
- To initialize mongdb service
mongod --dbpath=/usr/local/var/mongodb/db --replSet rs0
Redis
- Flush all data
/usr/local/bin/redis-cli -p 6379 FLUSHALL
Redis Command
- Install Command
npm install -g redis-commander- Run Command
redis-commander --redis-port 6379 --nosave --open - To access in browser goes to http://localhost:8081/
ElasticSearch Command
- Install ElasticSearch
cd /tmp
#cd config #elasticsearch.yml config port, authentication, etc. 9200
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-16.7.1.tar.gz
tar -zxvf elasticsearch-16.7.1.tar.gz
mv elasticsearch-16.7.1 /usr/local/opt/elasticsearch
cd /usr/local/opt/elasticsearch/
ln -s ../opt/elasticsearch/bin/elasticsearch /usr/local/bin/elasticsearch
ln -s ../opt/elasticsearch/bin/elasticsearch-cli /u sr/local/bin/elasticsearch-cli
ln -s ../opt/elasticsearch/bin/elasticsearch-env /usr/local/bin/elasticsearch-env
cd /usr/local/opt/elasticsearch/
elasticsearchRun as daemon
elasticsearch -d -p /usr/local/var/run/elasticsearch.pidIn case of error: Error [cluster_block_exception] blocked by: [FORBIDDEN/12/index read-only / allow delete (api)]
- Go to /usr/local/opt/elasticsearch/data/ and delete the content.
- Look this links: https://discuss.elastic.co/t/forbidden-12-index-read-only-allow-delete-api/110282/8 | https://selleo.com/til/posts/esrgfyxjee-how-to-fix-elasticsearch-forbidden12index-read-only
- In Kibana, run the command:
PUT /_settings { "index.blocks.read_only_allow_delete": null } - By curl command:
curl -XPUT -H "Content-Type: application/json" http://localhost:9200/_all/_settings -d '{"index.blocks.read_only_allow_delete": null}'
Kibana
- To install Kibana
cd /tmp
wget https://artifacts.elastic.co/downloads/kibana/kibana-6.5.4-darwin-x86_64.tar.gz
tar -zxvf kibana-6.5.4-darwin-x86_64.tar.gz
mv kibana-6.5.4-darwin-x86_64 /usr/local/opt/kibana
ln -s ../opt/kibana/bin/kibana /usr/local/bin/kibana- Run Command
Access on: http://localhost:5601kibana
Global Access
- To ngrok
- Authenticate with ngrok doing
ngrok authtoken PUT_HERE_THE_NGROK_ACCOUNT_TOKEN - To run the server with a defined domain: (ex: domain is fonttech)
./ngrok http 3000 -subdomain=fonttech -bind-tls=true - To run the server with a random domain:
./ngrok http 3000 -bind-tls=true
- Authenticate with ngrok doing
- To serveo
- Start the server running the command:
ssh -o ServerAliveInterval=60 -R font-tech:80:localhost:3000 serveo.net
- Start the server running the command: