Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/aryaman1706/froth_

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/aryaman1706/froth_
Owner: Aryaman1706
Created: 2020-05-20T18:58:57.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-06T04:23:16.000Z (almost 2 years ago)
Last Synced: 2023-03-08T03:53:24.393Z (over 1 year ago)
Language: JavaScript
Size: 1.4 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Froth_ | Forums for your College

> I am currently working on the application to make it more optimized and user friendly.

## How to Run the application on your machine?

1. Clone the repository :- `https://github.com/Aryaman1706/Froth_.git`

2. Navigate to the folder via command line.

3. Install [npm packages](https://www.npmjs.com/) for the backend :- `npm i`

4. Navigate to the client folder :- `cd client`

5. Install [npm packages](https://www.npmjs.com/) for the frontend :- `npm i`

6. Go back to the root folder :- `cd ..`

7. Start the Application :- `npm run dev`

## Technical Specification

> MERN Stack

**Frontend**

* React application bootstraped by [create-react-app](https://create-react-app.dev/).

* [Redux](https://redux.js.org/) - For state management.

* CSS framework :- [Materialize CSS](https://materializecss.com/).

* [Socket.io -client](https://github.com/socketio/socket.io-client#readme) package used to provide RealTime chat functionality.

**Backend**

* [Node.js](https://nodejs.org/en/) - JavaScript runtime built.

* [Express.js](https://expressjs.com/) - Minimal [Node.js](https://nodejs.org/en/) web application framework.

* [MongoDB](https://www.mongodb.com/) - Database service.

* [Socket.io](https://socket.io/) - To provide RealTime functionality.

* [Passport](http://www.passportjs.org/) - To help with user authentication.

## Screen Shots of the Application

![image](images_readme/1.PNG)

***

![image](images_readme/2.PNG)

***

![image](images_readme/3.PNG)

***

![image](images_readme/4.PNG)

***

![image](images_readme/5.PNG)

***

## Demo Video

[![Demo Video](images_readme/1.PNG)](https://www.youtube.com/watch?v=ncbzxdsiNDg)