# Install dependencies npm i # Serve using nodemon with hot reload npm run watch # Build for production npm run build # Lint the project with eslint npm run lint # Run tests npm run test ## knex Migrations ## Note - All knex migrate/rollback/seed calls must be prefaced ## with the setting of NODE_ENV - also, seeds and rollbacks are ## disabled in production # Migrate latest NODE_ENV=development knex migrate:latest # Rollback NODE_ENV=development knex migrate:rollback # Run all seeds NODE_ENV=development knex seed:run # Make migration knex migrate:make create_users_table # Make seed knex seed:make seed_users
If you want to turn on the rate-limiter, uncomment the rate-limiter block in
./src/index.js and make sure you have redis running. I use homebrew. You can follow this guide. After installing and running redis, you should be able to enter
redis-cli ping into a terminal and get
This backend is part of a pair of projects that serve a simple notes app. I chose a notes app because it gives you a good look at the different techniques used in both the frontend and backend world. What's really cool is these projects feature a fully fleshed-out user login/signup/forgot/reset authentication system using
I've liberally commented the code and tried to balance the project in a way that it's complex enough to learn from but not so complex that it's impossible to follow. It can be tough to learn from a boilerplate that has too much or too little.
Having used mainly
PHP for the backend in the past - I am very glad I checked out Koa as I think it is absolutely awesome in the way it handles the server code. Same thing with
React - I've used mainly
jQuery in the past - albeit with the really structured Revealing-Module-Pattern - and using
React was such a pleasure. You can really tell right away what kind of power a well-structured library can give you.
You'll need to create a
.env file and place it in the root of your directory. Take a look at
.example.env and add your information as needed. For
JWT_ACCESS_TOKEN_EXP you can set it to
5d etc - although
5m is what I'm using at the moment. Note - we don't set the
NODE_ENV variable in the
.env - we set it in the npm scripts. This lets us specifically set different environments as needed. Also make sure to set the
JWT_SECRET variable - something random around 32 characters.
This project only responds and listens in
JSON. Keep that in mind when send requests through
Insomnia or your frontend.
As mentioned in the frontend code, the user authentication process is this:
accessTokenand decode it using
jwt-decode. This gets us the logged in user's information. We stick this in the Vuex/Redux
userstore. Then we store the
accessTokenin the user's
accessTokenyou have to the call (using
401 TOKEN EXPIRED. When you see this - that means you need to send your
user.emailto the endpoint that deals with
src folder is the heart of the program. I'll go over its subfolders now.
We use controllers to keep our router thin. The controller's responsibility is to manage the request body and make sure it's nice and clean when it eventually gets sent to a
model to make database calls. There are two controller files present - one for user signup/login/forgot... and one for notes. Note: the
UserActionController.js is a little different then normal controllers, as I believe the actions of a user signup/login/forgot/reset are seperate from the normal actions for a user - so that's why
UserActionController.js in written in a more procedural way.
Here is our database setup. This project uses
Knex to manage migrations and execute queries. I initially wrote wrote all the
MySQL calls using raw
SQL, but the need for a migrations manager pushed me towards an
ORM for the
Knex is awesome - very powerful, easy to use and make queries, and the migrations are nice to have for sure - especially for testing.
For this project you'll need to make two databases in your development environment,
koa_vue_notes_testing. In your production environment you would just have
koa_vue_notes_production. Tests use a different database because the data there is extremely volatile - as table information is created and destroyed on every test. The
knexfile.js used here dynamically attaches to the proper database based the
knexfile.js in the root of the project is all setup with the ability to read your
.env file. Make sure to have knex installed globally,
npm install -g knex. Let's say you download this project - first you'll
npm i, then create a
koa_vue_notes_development database and a
koa_vue_notes_testing database, then
knex migrate:latest and
knex seed:run to create and seed your tables. Currently it's set up to make five users and 100 notes distributed to those users.
Docker is used for the development virtual machine and for building the production app. To use the included dockerfile.yml, run
docker-compose up -d --build to bring up the machine. To stop the machine, run
docker-compose down. The main reason docker is used in this case is to host the
MySQL database. Make a database named
koa-vue-notes_development. Connect through Sequel Pro using
user: root, and
Here I place any custom middleware the app is using. The custom middleware we're using is based on the
koa-jwt library - but I had to tweak it because it mysteriously didn't report an expired token correctly. Strange, as I thought that would be an important requirement. No biggie.
Our models folder contains two model files - one for users and one for notes. These models are where the actual database calls are made. This keeps things nice and neat - also make actions reusable for the future.
Very simple - here are our routes. I've broken it down into a few files - this keeps things in control. Each route is nice and thin - all it's doing is calling a controller. Some routes are using that jwt middleware I mentioned earlier. Koa make it really nice and easy to add middleware to a route. Very cool.
Static files - just used for the favicon.
index.js isn't a folder - it's the brain of the app. Here you'll see we are attaching a bunch of middleware to our
Koa instance. Very slick and straight-forward initialization.
This project uses
Jest for testing. Bascially, each API endpoint is tested with working request data to confirm the server behaves correctly when spoken to. Each time the tests are run the migrations get kicked into gear. After the tests are complete the testing database rolls-back - ready for the next test.
So, I added some basic TypeScript support because I've been really digging TypeScript lately. The implementation in this project is not perfect, but it's initialized and a good amount of the files are now converted. I'll get to the rest of the files as soon as I can, but the good news is that any new files needed going forward will be all set to write in TypeScript.
Go ahead and fork the project! Message me here if you have questions or submit an issue if needed. I'll be making touch-ups as time goes on. Have fun with this!
Copyright 2017 John Datserakis