Giter VIP home page Giter VIP logo

project-2-fun-facts's Introduction

Project-2-Fun-Facts

My second project within my coding cohort. This is a random fact generator, full stack application built by me. Here I am utilizing APIs, Fetch, ERDs, with programming languages such as Express, MongoDB, Liquid and Javascript.

Description

Welcome to the Fun Fact Generator! Here's the place where you can get some interesting fun facts that you'll be able to use as great conversation starters whether by the office water cooler, on a date, or even waiting in the doctor's office. Enjoy this endless amount of fun facts and ease of use!

API

Here's the base URL for this API: https://api.aakhilv.me

Installation Instructions

  1. Fork and Clone this repository
  2. Cd into the Project-2-Fun-Facts directory
  3. Run npm install to install the dependencies
  4. Touch .env .gitignore in the main directory
  5. Add node_modules and .env into the .gitignore folder.
  6. Check if you have nodemon installed by running npm install -g nodemon
  7. Run nodemon to start the server
  8. Run 'https://localhost:3000'
  9. Signup or Login to create an account to continue through the app.
  10. Enjoy and Favorite some Fun Facts! :)

User Information

As a user, you should be able to use this full stack application to:

  1. Receive random facts from database schema
  2. Log in/Sign Up in order to have a user profile within the app
  3. Save random facts to profile in order to have them logged within my profile
  4. Ability to journal/create information that relates to that specific fact.
  5. Delete any favorite facts that are no longer needed.
  6. The ability to log out and return to the main homepage/Index

Requirements

This will have elements of:

  • RESTful Routes (i.e. GET, POST, PUT and DELETE )
  • Utilize ODM to create a database table structure with MongoDB data
  • Incoportate API
  • Have models

CRUD Functionality

Facts and Journals Routes

VERB PATTERN ACTION DESCRIPTION MODEL
GET /facts Index Indexes with singular Fun Fact Facts
GET /facts/faves Show Shows User's fact they've favorited Facts
DELETE /:id Delete Deletes a User's specific fact they've favorited Facts
----------- ----------- ----------- ----------- -----------
GET /journals Index Shows all users Journal entries Journals
POST /journals Create Shows User's journaled 'fact' they've favorited Journals
GET /:id/edit Edit Edit your specific journal entry Journals
PUT /journals Update Shows the users updated Journal entry Journals
DELETE /:id Delete Deletes the users selected Journal entry Facts

WireFrames

  • Home Page img

  • Login img

  • Sign Up img

  • Fun Facts img

  • Favorites img

  • Journal img

  • Sign Out img

  • ERD img

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.