Code Monkey home page Code Monkey logo

rodde-it's Introduction

Rodde-It ✏️

Description

This full stack web application utilizes HTML, CSS, Handlebars, JavaScript, MySQL, Node.js, and Node Package Manager (bcrypt, connect-session-sequelize, dotenv, express, express-handlebars, express-session , handlebars, mysql2, sequelize) to build an MVP startup forum resembling Reddit. Through the implementation of the MVC paradigm, Object-Relational Mapping, CRUD functionality, template generating engines, and authentication features, users have the ability to:

  • Sign up and create an account
  • Log in as a returning user
  • Create, edit, view, and delete posts
  • Add comments to posts
  • Upvote or Downvote on posts
  • Navigate to Sign up, Log in, Home, Dashboard, and Edit pages

Visit the deployed Heroku site HERE

Table of Contents

Installation

Optional:

  • Prior to starting up the program, make sure you have Node.js, MySQL, and Insomnia installed onto your local computer for testing purposes.

  • To install this application, clone this repository onto your local computer, open it in your code editor, and run the following command on your terminal: npm install

  • Once all dependencies have been installed, create an environment variable file (.env) at the root level of this application with the following content for successful connection to the database:

    • DB_NAME = platform_db
    • DB_USER = <'mysql-username-here'> (If no username is set, default user for SQL is 'root')
    • DB_PW = <'mysql-password-here'> (If no password is set, by default SQL has no password)

Usage

Optional:

  • Once all packages have been installed, run the mysql shell command mysql -u root -p and enter your password (if one has been set) before running source db/schema.sql. Once completed, type exit.

  • After exiting the mysql shell, run the command npm start, npm run start OR node server.js on your terminal to turn on your server.

  • Once the server has been turned on, head over to Insomnia to test API GET, POST, PUT, and DELETE routes in order to create, read, update, and delete data from the SQL database.

Preview

Screenshot

License

  • This project is licensed under: ISC

Contribution

  • Forking this repository is always welcomed and encouraged!

If you encounter a problem with this application, please add an issue or pull request to the GitHub repository.

Questions

  • Please feel free to use this application at any time and visit our personal GitHub profiles to access other open source projects!

Credits

rodde-it's People

Contributors

denysha-abigail avatar amir-hackett avatar disha2022 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.