Git Product home page Git Product logo

sessions-ucp's Introduction

sessions-ucp

Installation

  1. Install packages

    npm install
    
  2. Configure DB. Create .env file in this format:

    NODE_ENV=development
    DB_NAME=name
    DB_USER=user
    DB_PASSWORD=pass
    DB_HOST=127.0.0.1
    SECRET=
    TOKEN_SECRET=
    

    SECRET and TOKEN_SECRET preferably shoud be randomly generated hashes.

    Optional fields

    ADMIN_LOGIN=
    ADMIN_MAIL=
    ADMIN_PASS=
    BUILT_IN_GZIP=
    TOKEN_EXPIRATION_TIME=
    

    TOKEN_EXPIRATION_TIME defaults to 1h, ADMIN_* fields are used in a seeder, which creates an admin user for the system.

  3. Init CLI

    npx sequelize-cli init
    
  4. Create DB

    npx sequelize-cli db:create --charset utf8mb4 --collate utf8mb4_unicode_ci
    
  5. Migrate

    npx sequelize-cli db:migrate
    

Development

To clear and re-migrate DB, use:

npm run refresh

Create admin user with data specified in .env:

npm run seed

To run project with nodemon:

npm run dev

Useful links

TODOs

  • Move admin stuff to route
  • Add rate limiter or express-brute and apply to the some auth routes
  • Experiment with gzip
  • Admin auth
  • Secret in env
  • Add option to disable gzip from .env
  • List all possible .env fields in README
  • Look at helmet
  • Move to fastest-validator
  • Add a cron job to empty invalidated tokens table
  • Document all routes
  • Move server from app.js

sessions-ucp's People

Contributors

alexrazor1337 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.