Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/opencodeiiita/scoop-backend


https://github.com/opencodeiiita/scoop-backend

backend beginner-friendly expressjs geekhaven mongodb nodejs opencode23

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README 

        
# SCOOP

Scoop is your window to the heartbeat of campus life. Engage, explore, and uncover the latest campus insights in real-time. This is your space to share and discover news that truly matters.



## Tech Stack 

* NodeJS

* ExpressJS

* MongoDB

* React



## 🚀 Features



1. **News Unleashed:**

   - Scoop is your go-to platform for breaking campus news. Share the latest updates, events, and noteworthy happenings with the community. Your news, your voice.



2. **Upvote Power**

   - Every user has the ability to shape the narrative. Upvote the most relevant and impactful news, ensuring that the most significant stories rise to the top.



3. **Verified Badge Prestige:**

   - Become a recognized campus news authority. The user with the most upvoted news profile earns a prestigious verified badge, symbolizing their influence and commitment to delivering quality information.



4. **Chronicle Rankings:**

   - Scoop doesn’t just share news; it prioritizes the most impactful stories. The most upvoted news articles secure a prime position at the top, ensuring that the campus community stays informed with the best content.



5. **Admin Dashboard:**

   - An admin will have the authority to delete or edit news shared by regular user.



6. **Community Informed**

   - Engage in meaningful discussions around the latest news. Foster a sense of community by sharing opinions, insights, and reactions to the stories that matter most.



## Join The Scoop Revolution

Scoop is a revolution in campus journalism. Together, let's elevate the way we share, consume, and engage with campus news. Your insights, your influence - let the Scoop revolution begin!

 

## Setup Guide

1. Create a .env file in the root directory.

2. Add your mongodb uri in the .env file (refer env.example file).

```bash

  npm install 

  npm run dev

```

Make sure you have required enviornment variables saved in the ```.env``` file in the root of the project. A file ```.env.example``` is attached for reference.



## Claim an issue

Comment on the issue. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel.



## Communication 

Whether you are working on a new feature or facing a doubt please feel free to ask us on our [discord](https://discord.gg/D9999YTkS8) channel. We will be happy to help you out.



## Guidlines 

Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.



- People before code: If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors.



- Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students/mentors section.



- Reference the issue numbers in the commit message if it resolves an open issue. Follow the [PR Template](https://github.com/opencodeiiita/SaveMyForm-Frontend/blob/main/.github/pull_request_template.md) Issue: < ISSUE NUMBER >



- Provide the link to live gh-pages from your forked repository or relevant screenshot for easier review.



- Pull Request older than 3 days with no response from the contributor shall be marked closed.



- Do not make PR which is not related to any issues. You can create an issue and solve it once we approve them.



- Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.



- Be polite: Be polite to other community members.



## API endpoints



### Users Routes:

- `POST /api/users/:userId/upvote`: Upvote a user. (auth required)

- `POST /api/users/:userId/downvote`: Downvote a user. (auth required)

- `GET /api/users/allUsers`: Get details of all users (admin access (isAdmin = 1) and auth required)

- `GET /api/user/:userId`: Get details of a user (auth required)

- `GET /api/user/:userId`: Get details of a user (auth required)

- `GET /api/user/:userId`: Get details of a user (auth required)

- `DELETE /api/user/delete/:userId`: Delete User Details (auth required with isAdmin=1)



### News Routes:

- `POST /api/scoop/post`: Allow users to post news (auth required)

- `POST /api/scoop/:scoopId/upvote`: Upvote a news. (auth required)

- `GET /api/scoop/:scoopId`: Get news details

- `DELETE /api/scoop/delete/:userId`: Delete news (auth required with admin access)

- `PATCH /api/scoop/:scoop`: Get details of a user (auth required)



### Home Routes:

- `GET /api/scoop/home/top`: Top 5 news sorted based on most number of upvotes on news 

- `GET /api/scoop/home/credible`: Latest news of top 5 profiles sorted based on most number of upvotes on profile

- `GET /api/scoop/home/categories`: Out of all the news in the database, return an array of all the tags used in all news. Ensure the array does not have duplicate entries

- `GET /api/scoop/home/latest`: Out of all the news in the database, return 5 latest news



### Authentication Routes:

- `POST /api/auth/register`: Register a new user.

- `POST /api/auth/login`: Authenticate and log in a user



### General Routes:

- `GET /api/scoop/top`: Sort all news according to most number of upvotes

- `GET /api/scoop/credible`: Sort news according to highest upvotes in the profile of the user who uploaded it

- `GET /api/scoop/latest`: Sort according to date and return the latest news



### Comments Routes:

- `GET /api/scoop/:scoopId/comments`: Get comments for a news article (Auth req.)

- `POST /api/scoop/:scoopId/comments`: Add a new comment to a news article (auth required) 

- `PATCH /api/scoop/:scoopId/comments/:commentId`: Edit a comment (auth required)