Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/baker-ling/bdbts

An online tech blog implemented in node.js with MySQL and Handlebars
https://github.com/baker-ling/bdbts

blogging cms handlebarsjs mysql sequelizejs

Last synced: about 2 months ago
JSON representation

An online tech blog implemented in node.js with MySQL and Handlebars

Awesome Lists containing this project

README

        

# bdBTS [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Description

An online tech blog implemented in node.js with MySQL and Handlebars

## Contents

- [Installation](#installation)
- [Usage](#usage)
- [Questions](#questions)
- [License](#license)

## Installation

To run this app on your local machine, you will need to run the following at the console.

```
git clone https://github.com/baker-ling/bdBTS
npm install
```

Next, you will need to resave the file `.env.EXAMPLE` as `.env` and type in values for `DB_PASSWORD` and `DB_USER` based on the configuration for your database.

Optionally, you can run `node seeds/seed.js` to populate the database with some initial data.

## Usage

Type `node server` at the console to launch the webserver on localhost. It will run on port 3001 by default.

### Deployed Instance
A version of the app is currently up and running [here](https://glacial-ravine-27881.herokuapp.com/).

### Features

You can view posts without being logged in. Click on any post title to bring up a post and its comments.

![Homepage screenshot](./doc/screen_captures/home.png)

You must log in or sign up for account in order to add posts or comments of your own.

![Log in page](./doc/screen_captures/login.png)

After you logged in, you can add comments.

![Post with comment form](./doc/screen_captures/post_comment.png)

You can also go to the dashboard to add, edit, or delete posts.

![Dashboard screenshot](./doc/screen_captures/dashboard.png)

One warning about the dashboard: the delete button will not ask for confirmation. Be careful!

Finally, when you are done posting content, you can log out by clicking the "Log out" button in the nav bar. If you don't log out, you will stay logged in for 24 hours from when you logged in.

## Questions

If you have any questions, feel free to reach out via one of the following:

- Email: [[email protected]](mailto:[email protected])
- Github: @baker-ling

## License

This application is distributed under the terms of [MIT License](./LICENSE).