Bugs Diaries

Share insights, tips,
and news related to technology!

Bugs Diaries Official Site

---

Description

Bugs Diaries allows writers to publish, edit, and manage their articles with ease. They can format their content using a variety of styling options. The site also has a commenting system that enables readers to interact with authors, ask questions, and share their thoughts.

This blog site is constantly updated with new content, ensuring that developers always have access to the latest information on technology trends, best practices, and emerging technologies. With its rich collection of articles, the Bugs Diaries site is an invaluable tool for anyone looking to stay informed and stay ahead in the ever-evolving world of technology.

Table of Contents

• Description
• Installation
  • Cloning the Repository
  • Prerequisites
  • Setting Up
• Mock-Up
• Usage
• Questions
• Contributing
  • Contributing Guidelines
  • Code of Conduct
• Credits
  • Authors
  • Acknowledgements
• License

Installation

Cloning the Repository

Click <> code - the green button. After clicking, in the local tab, copy the SSH key. Open the terminal in your Macbook or git bash, if you have Windows/Linux, and type:

git clone [paste ssh key]

I would recommend downloading Visual Studio Code to edit the code locally. If you need more information on how to clone a repository, click here!

Prerequisites

This package requires you to have Node.js, npm, Inquirer, Express.js and MySQL2 installed on your machine. You can install these by running the code below on your terminal:

For npm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

For Node.js

npm i node@lts

For Express.js

npm i express

Setting Up

Open the project in VS Code and make sure you are in the directory of this application before installing the dependencies. To install it, type the commands below on your terminal:

For MySQL2

npm i mysql2

For Sequelize

npm i sequelize

For Express Handlebars

npm i express-handlebars

For Express Session

npm i express-session

For Connect Session Sequelize

npm i connect-session-sequelize

For bcrypt

npm i bcrypt

For dotenv

npm i dotenv

You can also open the project in VS Code, make sure you are in the directory of this application and then type the command below on your terminal:

npm i

Once you run this, npm will begin the installation process of all of the current project's dependencies.

Mock-Up

The following images shows the web application's appearance:

Usage

Launch the application by entering the command below on your terminal:

npm start

And then have fun in your browser!

Questions

For questions and support feel free to contact me via:

📧 Email

🐈‍⬛ GitHub

Contributing

Contributing Guidelines

Want to report a bug, contribute some code, request a new feature, or improve the documentation? You can submit an issue and we will gladly review it, but before submitting an issue, please search the issue tracker, as it may already exist!

Code of Conduct

Our Code of Conduct follows the same principles as the Contributor Covenant, version 2.1.

Credits

Authors

👩🏻‍💻 Larissa Guilherme

Acknowledgements

• W3 Schools
• MDN
• Node.js
• NPM
• README Lab
• Express.js
• MySQL
• MySQL2
• Stack Overflow
• dotenv
• Sequelize
• bcrypt
• Express Session
• Express Handlebars
• Connect Session Store using Sequelize
• Handlebars

License

Please refer to the LICENSE in the repo.