Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victoriamcn/tech-blog
A CMS-style blog site similar to a Wordpress site, where developers can publish their blog posts and comment on other developers’ posts as well.
https://github.com/victoriamcn/tech-blog
express expressjs heroku javascript mysql nodejs spectre-css
Last synced: about 7 hours ago
JSON representation
A CMS-style blog site similar to a Wordpress site, where developers can publish their blog posts and comment on other developers’ posts as well.
- Host: GitHub
- URL: https://github.com/victoriamcn/tech-blog
- Owner: victoriamcn
- License: mit
- Created: 2023-04-24T17:26:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-04T02:50:04.000Z (over 1 year ago)
- Last Synced: 2024-11-16T19:25:44.715Z (2 months ago)
- Topics: express, expressjs, heroku, javascript, mysql, nodejs, spectre-css
- Language: JavaScript
- Homepage: https://git.heroku.com/sheltered-oasis-68094.git
- Size: 120 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tech-Blog
A CMS-style blog site similar to a Wordpress site, where developers can publish their blog posts and comment on other developers’ posts as well.
## Table of Contents
- [Deployed Application](#deployed-applicaiton)
- [User Story](#user-story)
- [Installation and Usage](#installation-and-usage)
- [MVC Paradigm](#mvc-Paradigm)
- [Other npm Packages](#other-npm-packages)
- [Contributing](#contributing)
- [Questions](#questions)
- [License](#license)
- [Credits](#credits)
- [Badges](#badges)
## Deployed Application
[https://git.heroku.com/sheltered-oasis-68094.git](https://git.heroku.com/sheltered-oasis-68094.git)
## User Story
```
AS A developer who writes about tech
I WANT a CMS-style blog site
SO THAT I can publish articles, blog posts, and my thoughts and opinions
```
## Installation and Usage
1. Clone this repository to your local computer.
2. Open the repo in ```VS Code```.
3. Open the server.js file in the Integrated Terminal.
4. Log-in to ```MySQL```.
5. **Create your own .env file:**
- Add new file called ```.env```
- Use following syntax in your ```.env``` file with your ```MySQL``` username and password instead of ```example```:
```
DB_NAME='techblog_db'
DB_PASSWORD='example'
DB_USER='example'
```
6. **Install all dependencies:** type the following in the command line: ```npm i```.
7. **Create the SQL database locally** [Refer to this documentation to get started:](https://dev.mysql.com/doc/mysql-getting-started/en/). This covers installation for both Windows and MacOS.
8. ***Optional*** **Seed the database:** type the following in the command line: ```npm run seed```.
9. **Start the server:** type the following in the command line: ```npm start```.
## MVC Paradigm
- Model: [mysql2](https://www.npmjs.com/package/mysql2) packages to connect to a MySQL database.
- Model: [sequelize](https://www.npmjs.com/package/sequelize) packages to connect to a MySQL database.
- View: [express-handlebars](https://www.npmjs.com/package/express-handlebars).
- Controller: Created an [Express.js](https://expressjs.com/en/starter/installing.html) API.
## Other npm Packages
- [dotenv](https://www.npmjs.com/package/dotenv) package to use environment variables
- [bcrypt](https://www.npmjs.com/package/bcrypt) package to hash passwords
- [connect-session](https://www.npmjs.com/package/express-session) package to add authentication
- [connect-session-sequelize](https://www.npmjs.com/package/connect-session-sequelize) package to add authentication
## Contributing
To contribute to this project, you may create a git fork.
## Questions
 To view my other projects, you may visit my Git Hub profile: [victoriamcn](https://github.com/victoriamcn).
 To contact me or see my resume, please visit my LinkedIn profile: [Victoria McNorrill](https://www.linkedin.com/in/victoria-mcnorrill/)
## License
[MIT](https://img.shields.io/badge/License-MIT-blue.svg)
This project is licensed under MIT.
- [Click](https://pitt.libguides.com/openlicensing/MIT#:~:text=Users%20of%20software%20using%20an,and%20the%20X%20Windows%20System.) here to view the license documentation or,
- Go to the [license file](https://github.com/victoriamcn/Tech-Blog/blob/main/LICENSE) with in this repository.
## Credits
### Georgia Tech Staff
- My instructor, [Saurav Khatiwada](https://github.com/khatiwadasaurav).
- My tutor, Juan Delgado.
### Example Code
- I based my code on the Module 14: Model-View-Controller (MVC) Mini-Project in the Georgia Tech Boot Camp.
### Tutorials
- StackOverflow: [TypeError: app.use() requires middleware functions](https://stackoverflow.com/questions/32883626/typeerror-app-use-requires-middleware-functions)
- The Full-Stack Blog: [Deploy with Heroku and MySQL](https://coding-boot-camp.github.io/full-stack/heroku/deploy-with-heroku-and-mysql)
- The Vanilla JS Toolkit: [Element.addEventListener()](https://vanillajstoolkit.com/reference/event-listeners/addeventlistener/)
- YouTube: [Deploying to Heroku with Sequelize and JawsDB](https://www.youtube.com/watch?v=AQp7b-1356k)
## Badges
### Cloud
### Database
### Frameworks and Libraries
### Integrated Development Environments (IDE)
### Languages
### Linters
### ORM
