https://github.com/simonapiz/thescoop

An article submission web app - I created all of the routing and database logic
https://github.com/simonapiz/thescoop

api-rest codecademy-solutions database-management http-requests javascript server

Last synced: 5 days ago
JSON representation

An article submission web app - I created all of the routing and database logic

• Host: GitHub
• URL: https://github.com/simonapiz/thescoop
• Owner: SimonaPiz
• Created: 2023-10-11T09:56:49.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-17T08:10:28.000Z (about 1 year ago)
• Last Synced: 2024-01-29T21:40:27.603Z (11 months ago)
• Topics: api-rest, codecademy-solutions, database-management, http-requests, javascript, server
• Language: JavaScript
• Homepage:
• Size: 673 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#   The Scoop

> An article submission web app - I created all of the routing and database logic



## Table of Contents

* [General Info](#general-information)

    * [Features](#features)

    * [Implementation Details](#implementation-details)

    * [Test](#test)

* [Technologies Used](#technologies-used)

* [Setup](#setup)

* [Acknowledgements](#acknowledgements)

* [Author](#author)

## General Information

### Features

The Scoop allows users to:

- Create and log in to custom username handles

- Submit, edit, and delete articles containing a link and description

- Upvote and downvote articles

- Create, edit, and delete comments on articles

- Upvote and downvote comments

- View all of a user's articles and comments

You can view all of this functionality in action in the video below: [▶](https://content.codecademy.com/programs/build-apis/solution-videos/TheScoopFinal480.mov)

### Implementation Details

To complete this project, I needed to add for Comments:

  - [x] the database information

    - ✔ [issue 3](https://github.com/SimonaPiz/TheScoop/issues/3)

  - [x] and server routes

    - ✔ [issue 4](https://github.com/SimonaPiz/TheScoop/issues/4)

Bonus: YAML Saving and Loading

  - [x] I used YAML for saving the database object to ensure it is able to be restored. Functions:

    - **loadDatabase**

    - **saveDatabase**

    - ✔ [issue 6](https://github.com/SimonaPiz/TheScoop/issues/6)

### Test

A testing suite has been provided.

- ✔ All test passed

  

  ![test results](https://user-images.githubusercontent.com/91121660/274607082-1d3a9940-6dca-4c51-a3a5-358651c1e8d7.png)

## Technologies Used

   - React 15

   - React router dom 4

   - chai 4

   - mocha 6

   - yaml 2

## Setup

To start the server, run 

```

  $ npm install

``` 

and then 

```

  $ node server.js

``` 

from the root directory of this project.

To view your local version of the site, open **index.html** in a web browser.

## Acknowledgements

This project comes from the [Codecademy's Create a Back-End with JavaScript](https://www.codecademy.com/learn/paths/create-a-back-end-app-with-javascript) course.

## Author

- [Simona Pizio](https://github.com/SimonaPiz)