Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajibs/hotspots
Discover the best night clubs around you or in any location in the world and RSVP ahead of time.
https://github.com/ajibs/hotspots
babel expressjs google-api mongodb nodejs pugjs typeahead webpack3
Last synced: about 6 hours ago
JSON representation
Discover the best night clubs around you or in any location in the world and RSVP ahead of time.
- Host: GitHub
- URL: https://github.com/ajibs/hotspots
- Owner: ajibs
- License: other
- Created: 2017-10-12T15:49:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-02T08:36:58.000Z (about 7 years ago)
- Last Synced: 2024-12-09T22:22:14.626Z (about 2 months ago)
- Topics: babel, expressjs, google-api, mongodb, nodejs, pugjs, typeahead, webpack3
- Language: JavaScript
- Homepage: https://hotspots-tonight.herokuapp.com
- Size: 354 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hotspots
Discover the best night clubs around you or in any location in the world and RSVP ahead of time.
Hotspots is a [FreeCodeCamp](https://www.freecodecamp.org/) 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:
- [Production](https://hotspots-tonight.herokuapp.com)
## 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:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en/download/)
- [MongoDb](https://www.mongodb.com/download-center#community)
- [Yarn](https://yarnpkg.com/en/docs/install)
## Setup
#### Local Copy
To create a local copy, run the following in your terminal:
```bash
git clone https://github.com/ajibs/hotspots.git
```
Then change into the local directory, run the following in your terminal:
```bash
cd hotspots
```
#### Install Node.js and Yarn
If you don't have Node.js installed, please go ahead and grab it [here](https://nodejs.org/). 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](https://yarnpkg.com/en/docs/install).
To confirm that you have Node.js installed, run the following in your terminal:
```bash
node -v
```
You should get something like `v8.9.1`.
To confirm that you have Yarn installed, run the following in your terminal:
```bash
yarn -v
```
You should get something like `1.3.2`.
#### Setup Database and .env file
You can setup a database on [mlab](https://mlab.com/). 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:
```bash
yarn
```
## Development
To kickstart the application, run the following in your terminal:
```bash
npm start
```
To continue full-stack development on this project, run the following in your terminal:
```bash
npm run dev
```
## Built With
- [Git](https://git-scm.com/) - Version Control
- [Node.js](https://nodejs.org/) - JS Runtime Environment
- [Yarn](https://yarnpkg.com) - Package Manager
- [Express](https://expressjs.com/en/starter/installing.html) - Web Framework
- [Pug](https://pugjs.org/api/getting-started.html) - Templating Engine
- [Webpack](https://webpack.js.org/) - Build Tool
- [Babel](https://babeljs.io/) - Transpiler
- [mLab](https://mlab.com/) - Database
- [Heroku](https://heroku.com) - Hosting and Continuous Deployment
- [VS Code](https://code.visualstudio.com/) - Code Editor
- [Chrome](https://www.google.com/chrome/browser/desktop/index.html) - Browser
## Contributing
Contributions are welcome
## Author
* [Bolu Ajibawo](https://github.com/ajibs)
## License
[MIT](https://github.com/ajibs/hotspots/LICENSE.md)
## Acknowledgments
* [Jordan Sobovitch](https://github.com/JordanSobovitch/nightlife-app)
* [FreeCodeCamp](https://www.freecodecamp.org/)
* [Chingu](https://chingu-cohorts.github.io/chingu-directory/)
* Red Pandas
* Developer Community
* Family and Friends