README.md

VueMe

Flat-file CMS (Content Management System) powered by Vue.js and Express.js.

This is the main package for the VueMe project. No theme is included in this package. A default theme will eventually be provided for guidance.

Contents

• Requirements
• Installation & Usage
  • Setup
  • Accessing the admin panel
• Configuration
  • Config options
• Contributing
• License

Requirements

• Node.js (and NPM)
• Express

Installation & Usage

Setup

Clone the package and remove git.

$ git clone git@github.com:rideron89/vueme.git project-name
$ cd project-name
$ rm -r .git/

Install dependencies and startup the project.

$ npm install
$ npm run start

Accessing the admin panel

By default, the admin panel is located at http://localhost:3000/admin. A default user has been set up with the following credentials:

Username: admin

Password: admin

Note: The password should be changed before deploying to production.

Configuration

VueMe uses dotenv configuration with a .env file in the project's root directory. An example is provided:

$ cp .env.example .env

Config options

# Secret key used for authentication (should be changed for each project)
AUTH_KEY=tm[1Inl?5-1!(4XO7+]yDl97nVpH#f

# Server port number
PORT=3000

# Number of salt rounds used for password hashing
SALT_ROUNDS=10

# Theme used in the front-end
THEME=default

You can generate an auth key from here: https://randomkeygen.com

You can read about bcrypt and salt rounds here: https://github.com/kelektiv/node.bcrypt.js#a-note-on-rounds

Contributing

Any and all contributions are greatly appreciated. If you wish to help, please refer to the Contributions guidelines.

License

MIT