Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 1.61 KB

README.md

File metadata and controls

36 lines (20 loc) · 1.61 KB

The NeighborHood

The NeighborHood is a platform for finding and building local communities. People use NeighborHood to meet new people, learn new things, find support, get out of their comfort zones, and pursue their passions, together.

The NeighborHood emulates the experience of MeetUp yet is more geocentric and its communication is depended on SMS.

This is a JavaScript application that implements React.

How to Install The NeighborHood

Use your terminal to navigate into the place where you want to clone The NeighborHood directory and git clone the url.

In the project directory, you can run:

npm install

This will install all necessary packages found in the package.json file to run this frontend.

Make sure you run rails s for the backend server needed for this app( The NeighborHood API: https://github.com/DDuongNguyen/neighbor-meet ), then run

npm start

This should open up your browser to the welcome page!

How to Use The NeighborHood

The NeighborHood makes requests to it's backend and allows its users to:

Create, read, and update their accounts with the help of JavaScript Web Token,Local Storage, and Bcrypt.

Join and unjoin an event that is hosted by other users on Google Map.

Create an event through a calendar section. Upload images for events using Active Storage.

User can also communicate with each other through SMS given legitimate phone number on their profile.

License

This project is licensed under the Learn.co Educational Content License. Please read LICENSE.md location in the directory or click on the following link (http://learn.co/content-license) for further details.