A static blog with fun Nintendo-themed user authentication built with Hexo, Koa, and NESS.css. It is generated and powered by Node.js.
nes-auth-blog uses Hexo with a customized aath theme to render your markdown files into a static blog. It then runs a lightning-fast Koa server with static user authentication to serve the blog.
It is intended as a private, simple, lightweight, and zero-configuration blog for sharing internal or personal documentation across a small group of people via Markdown - beloved by developers the world over - as the preferred writing medium.
It leverages the use of Git for keeping track of changes in authorship of blog posts and publications, and for easy deployment.
- Clone the repo.
- Create, edit, and place your markdown
.mdfiles (blog posts) in thesource/_postsdirectory. - Add your authorized users to the array in the
server/users.jsonfile as a{ "name": "user", "password": "pword" }object.
To run an instance of nes-auth-blog simply run the npm install and npm start commands in the root of the repository directory and open a browser window to http://localhost:3000/.
The default credentials to access the blog are username admin and password root. Please remember to remove the default credentials before deploying to secure your blog.
To configure your blog title and other information, open and edit your _config.yml file.
For more Hexo-specific configuration please refer to the Hexo documentation.
You can configure two environment variables at deployment time or at development time with dotenv:
SESSION_SECRET- the key used to encrypt and store the session cookie on the client-sidePORT- the port number for the server
You are encouraged to make this project your own by customizing the server authentication styles under server with a framework like PSone.css and with a different Hexo theme.
- Super Mario Photo by zengxiao lin on Unsplash
- Power up Photo by Geeky Shots on Unsplash
MIT License
Copyright (c) 2018 Damián Adams
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.