Pisky Project
Get the latest version of node from the official website or using nvm Nvm approach is preferred.
Run npm install or yarn from rootpath of the project.
Before running the app, make sure you have postgresql installed and a db created, to create it run the following steps inside a psql terminal:
- CREATE DATABASE db_project_name;
- \c db_project_name
- CREATE ROLE "project_name" LOGIN CREATEDB PASSWORD 'project_name';
Then, set in .env some variables:
- DB_HOST=localhost
- DB_PORT=5432
- DB_USERNAME=project_name
- DB_PASSWORD=project_name
- DB_NAME=db_project_name
- DB_NAME_DEV=db_project_name_dev
- DB_NAME_TEST=db_project_name_test
- API_DATE=X-API-Date
- PACKAGE_VERSION=X-Package-Version
- NODE_VERSION=X-Node-Version
To create a migration, run ./node_modules/.bin/sequelize migration:create --name="my-migration-name" --config ./migrations/config.js --migrations-path ./migrations/migrations.
To run them, execute npm run migrations.
Before running the app, make sure you have mongoDB installed and a db created, to create it run the following steps inside a terminal:
- mongo
- use db_project_name
- db.createUser({user:"root", pwd:"superpass", roles:[{role:"root", db:"db_project_name"}]})
- exit from mongo
- mongo -u root -p superpass --authenticationDatabase db_project_name
Then, set in .env some variables:
- DB_HOST=localhost
- DB_PORT=5432
- DB_USERNAME=project_name
- DB_PASSWORD=project_name
- DB_NAME=db_project_name
- DB_NAME_DEV=db_project_name_dev
- DB_NAME_TEST=db_project_name_test
- API_DATE=X-API-Date
- PACKAGE_VERSION=X-Package-Version
- NODE_VERSION=X-Node-Version
Now, we have two ways to start an app. To start your app in production mode run npm start in the root path of your project. To start your app in development mode (nodemon) run npm run start-dev. Then access your app at localhost:port. The port is logged in the console where you ran the start script.
By default, the environment will be development, but you can easily change it using the NODE_ENV environmental variable.
Dotenv is used for managing environment variables. They are stored in the /.env file. Take into account that the variables defined in the bashrc are not overrided.
The environment variables should be added to the .env file in the form of NAME=VALUE, as the following example:
DB_USERNAME=root
DB_PASS=superpass
DB_PASSWORD=superpass
PORT=8081
CLIENTS_API=http://api.clients.example.org/
Remember not to push nor commit the .env file.
To log useful information of your program to the console you just need to import the logger located at app/logger. There are two possible types of logging: info and error. You should use them depending on the type of message you want to show.
Here is an example snippet:
const logger = require('/app/logger');
...
if (error) {
logger.error('There is an error);
} else {
logger.info('There is no error);
}
To run your tests you first need to config your testing database by setting the env var DB_NAME_TEST. as explained
before in Database configuration. Also you need to run the migrations in this exclusive
testing database each time you have new ones, you can do this by running the command npm run migrations-test.
Once you have all the above done you can run your tests with the following command: npm test. For more information refeer to the documentation of Jest.
To simplify your tests, you can call the factoryByModel('nameOfModel') function in factory_by_models.js on your code, then, factory.build('nameOfModel') and it will define a json object with the attributes form the model you've passed as parameter taking random values. If you want to acceed to the object created, the values created will be on its dataValues field.
Remember that you have to create a model before, and the nameOfModel will be the one you will have on the database (which is the first parameter on sequelize.define()).
Factory By Models have also two additional functions, factoryAllModels() and factoryWithPredeterminatedValue('nameOfModel', 'nameOfAttribute', 'value'). The first one will define factories for ALL the models you have, so you don't have to worry to declare a factory every time you want to build another. The second one, maybe you have a customized attribute in your model, or with some values we don't know. So you may use it, you will have to pass the name of the model, the attribute name and the value you want it to have.
Also, it takes values predefined in the type field (Sequelize Datatype) and the validations you have in your MODEL (validate field),so if you want to validate those values on middlewares or somewhere else, factoryByModel won't take this in count. We strongly recommend to check if those validations cover the cases you expect, and if it doesn't, you can add your own code on this file (or just define a new factory).
As we know, a NodeJS application is not something easy to debug and because of that we've added the --inspect flag to make it simpler. You can download a node inspection manager for Chrome, so Chrome DevTools will automatically start when you run your app using npm run start-dev, making your debugging easier. You can read more about the different inspector clients here: https://nodejs.org/de/docs/guides/debugging-getting-started/#inspector-clients
We can use a node console with npm run console. There your service objects are exposed as servicename + "Service". Let's suppose that we have a service users which has a function getAll. In your console you can call usersService.getAll() and see the result. Note that this works also with functions that return promises! To exit the console use .exit.
Documentation will be served at /docs. We use OpenAPI A.K.A Swagger. Check this link for more details on how to use it.
Pushing the desired branch to heroku should be enough. For more information check: https://devcenter.heroku.com/articles/getting-started-with-nodejs#define-a-procfile.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Run the tests (
npm test) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
This project is maintained by Wolox and it was written by Wolox.
apithon-2019-node is available under the MIT license.
Copyright (c) 2019 Wolox
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.