votejs
v0.1.7
Published
This is a voting application using NodeJS.
Downloads
11
Maintainers
Readme
votejs
This is a voting application using NodeJS.
Prerequisite
We will need the following to be installed on our system.
- Node v10 or above
- NPM v6 or above
- Postgres v10 or above
Getting started
Run the following command to install all the packages.
➜ npm install
Environment
Set the environment by setting the environment variable NODE_ENV
.
Allowed values: dev, stage, prod
➜ export NODE_ENV=dev
Encryption Key
Set the encryption key as environment variable. Make sure it is exactly 256 bits long (32 characters).
➜ export ENCRYPTION_KEY=crypto-key-exactly-32-chars-long
Note! Encryption algorithm used: aes-256-cbc
and IV length is 16
.
Database setup
Create a database in Postgres. Then export the following environment variables.
On my local machine the host, user, password, database and port for Postgres are the following.
Note! If you have some other values then use that.
➜ export DB_HOST=localhost
➜ export DB_USER=
➜ export DB_PASSWORD=
➜ export DB_DATABASE=votejs
➜ export DB_PORT=5432
For more details check the NOTES.md file.
Seed
Run the following command to insert the seed data in database.
➜ npm run db:seed
Demo admin for DEV environment
For development environment the following demo admin account is created when you run the db:seed
command.
You can use the demo admin to explore the APIs in dev environment.
{
userName: 'demo.dev.admin',
emailId: '[email protected]',
password: 'root1234'
passcode: '123456'
}
You will find this in seed/admin.js
file.
Demo voter for DEV environment
For development environment the following demo voter account is created when you run the db:seed
command.
You can use the demo voter to explore the APIs in dev environment.
{
userName: 'demo.dev.user',
emailId: '[email protected]',
password: 'root1234'
passcode: '123456'
}
You will find this in seed/voter.js
file.
DOCUMENTATION
License
It's free :smiley:
MIT License Copyright (c) 2020 Yusuf Shakeel
Back this project
If you find this project useful and interesting then feel free to support me on Patreon.
Donate
Feeling generous :smiley: Donate via PayPal