Skip to content

README.md

Latest commit

 

History

History
121 lines (87 loc) · 3.49 KB

README.md

File metadata and controls

121 lines (87 loc) · 3.49 KB

Hotspots

Discover the best night clubs around you or in any location in the world and RSVP ahead of time.

Hotspots is a FreeCodeCamp Project.

Feature List

  • View night clubs in your location.
  • View night clubs in any city in the world.
  • Authenticated user can indicate as going to a night club.
  • Authenticated user can remove from going to a night club.
  • Google typeAhead.
  • On Login automatically search for night clubs close to a user's location.
  • Signup, Login and Logout of the app with Facebook, Google, Twitter or Local Login.
  • Connect all social media accounts to one single login account.

Getting Started

Hotspots is hosted on Heroku and can be accessed here:

Prerequisites

These are what you need installed on your computer to use the application:

  • Web Browser (Chrome, or Mozilla, or Safari, or Opera, or Microsoft Edge )

For Developers:

Setup

Local Copy

To create a local copy, run the following in your terminal:

git clone https://github.com/ajibs/hotspots.git

Then change into the local directory, run the following in your terminal:

cd hotspots

Install Node.js and Yarn

If you don't have Node.js installed, please go ahead and grab it here. This project uses ES6+ features and requires Node version >= 7.6.0 and <=8.9.1

Yarn is a package manager for Node.js and can be installed from here.

To confirm that you have Node.js installed, run the following in your terminal:

node -v

You should get something like v8.9.1.

To confirm that you have Yarn installed, run the following in your terminal:

yarn -v

You should get something like 1.3.2.

Setup Database and .env file

You can setup a database on mlab. You should also create a .env file using .env.sample as a prototype.

Install Node.js Modules

To install all dependencies, run the following in your terminal:

yarn

Development

To kickstart the application, run the following in your terminal:

npm start

To continue full-stack development on this project, run the following in your terminal:

npm run dev

Built With

Contributing

Contributions are welcome

Author

License

MIT

Acknowledgments