https://github.com/shenoy-anurag/simple-reddit

A forum like Reddit for anyone to post, rate and comment on content.
https://github.com/shenoy-anurag/simple-reddit

angular golang mongodb software-engineering

Last synced: 5 days ago
JSON representation

A forum like Reddit for anyone to post, rate and comment on content.

• Host: GitHub
• URL: https://github.com/shenoy-anurag/simple-reddit
• Owner: shenoy-anurag
• License: mit
• Created: 2022-01-10T21:17:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T16:29:18.000Z (over 2 years ago)
• Last Synced: 2024-06-20T12:50:19.857Z (11 months ago)
• Topics: angular, golang, mongodb, software-engineering
• Language: Go
• Homepage:
• Size: 2.89 MB
• Stars: 3
• Watchers: 4
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Simple Reddit

https://github.com/shenoy-anurag/simple-reddit

[![angular build](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/angular-build.yml/badge.svg?branch=main)](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/angular-build.yml)

[![go build](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/go-build.yml/badge.svg?branch=main)](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/go-build.yml)

[![go tests](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/go-tests.yml/badge.svg)](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/go-tests.yml)

[![AWS Deploy](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/ci-cd-aws.yml/badge.svg)](https://github.com/shenoy-anurag/simple-reddit/actions/workflows/ci-cd-aws.yml)

Frontend is deployed to 

Backend is deployed to 

### Description:

Simple Reddit is inspired from THE Reddit. It is being built as semester long project for the course Software Engineering - CEN 5035 at the University of Florida. Simple Reddit is a forum for anyone to post content and comment on posts built using Angular JS, Go, and MongoDB.

The aim of the project is to use Agile methodologies to quickly develop shippable code and to iteratively improve the product based on feedback.

We are using Github Projects to manage our Sprints, writing user stories as Issues and building functionality to close issues and achieve milestones. We are also documenting the project on the repo’s [wiki](https://github.com/shenoy-anurag/simple-reddit/wiki).

Users will be able to:

* Create accounts

* Create communities

* Create/edit/delete posts

* View posts on communities

* Comment on posts

* Upvote/Downvote posts

* Upvote/Downvote comments

* Save posts and comments to their profile

## Built With

* [Angular 14](https://angular.io/guide/setup-local) - The Angular JS framework used to develop the front end.

* [GoLang](https://go.dev/) - The language used to develop the back end.

* [MonogoDB](https://www.mongodb.com/) - Database used to store and manage information.

## Getting Started

### Install

* [Angular 14 & AngularCLI](https://angular.io/guide/setup-local)

* [Go](https://go.dev/doc/install)

* [MongoDB](https://docs.mongodb.com/manual/installation/)

More on how to setup the Back-end is available [here](https://github.com/shenoy-anurag/simple-reddit/blob/main/backend/Readme.md).

More on how to setup the Front-end can be found [here](https://github.com/shenoy-anurag/simple-reddit/blob/main/frontend/forum-app/README.md).

## Documentation, API Reference and Tutorials

[Documentation](https://github.com/shenoy-anurag/simple-reddit/wiki), 

[API Reference](https://github.com/shenoy-anurag/simple-reddit/wiki/API-Overview), 

[Video Tutorials](https://github.com/shenoy-anurag/simple-reddit/wiki/Demo).

## Sprint 1

Summary of Sprint 1 is [here](https://github.com/shenoy-anurag/simple-reddit/blob/800f7f3ab01ff884d0130f8386bbea5ba3a27b0c/Sprint1.md).

## Sprint 2

Summary of Sprint 2 is [here](https://github.com/shenoy-anurag/simple-reddit/blob/main/Sprint2.md).

## Sprint 3

Summary of Sprint 3 is [here](https://github.com/shenoy-anurag/simple-reddit/blob/main/Sprint3.md).

## Sprint 4

Summary of Sprint 4 is [here](https://github.com/shenoy-anurag/simple-reddit/blob/main/Sprint4.md)

## Authors

* **Manoj Jampana** - [manojjampana](https://github.com/manojjampana)

* **John Ng** - [NgJohn15](https://github.com/NgJohn15)

* **Ganesan Santhanam** - [ganesansanthanam](https://github.com/ganesansanthanam)

* **Anurag Shenoy** - [shenoy-anurag](https://github.com/shenoy-anurag)

## Backend Developers

* [Anurag Shenoy](https://github.com/shenoy-anurag)

* [Ganesan Santhanam](https://github.com/ganesansanthanam)

## Frontend Developers

* [John Ng](https://github.com/NgJohn15)

* [Manoj Jampana](https://github.com/manojjampana)

See also the list of [contributors](https://github.com/shenoy-anurag/forum/graphs/contributors) who participated in this project.

## Contact information:

For questions, please contact [email protected]