/yelpCrawl

Primary LanguageJavaScript

The Walking Drunk

About this Project

The aim of the project is to develop a central codebase that can be used by future developers to quickly modify the front-end, back-end, and to create new web applications as needed. It will provide a central database for storing generated routes and relevant Pub information.

This codebase utilizes the ReactJS front-end framework. Website data is stored in a MongoDB database. Manipulation of the database is done through Mongoose , an Object Relational Mapping framwork. Database migrations can be handled using another ORM that supports multiple types of databases.

For easier styling, we will be using Materialize, a popular responsive, mobile friendly front-end framework. To ensure visual cohesion, developers are encouraged to use available templates already created and implemented. Developers are advised to stick to the coding conventions and practices that are already used to ensure the project is extensible for all future developers.

Developers

Requirements

  • Linux or Mac OS X
  • NodeJS
  • npm
  • MongoDB
  • (the remaining dependencies will be installed below using npm)

Setting Up

Unix System via Command Line

1.) Make sure all requirements (listed above) has been met.

2.) Start your MongoDB server.

3.) Run 'npm install' to install dependencies.

4.) Run 'npm start' to start server.

5.) Run 'npm run build' in a different tab to run Webpack in production mode.

5.) Run 'npm run dev' to run Webpack in the watch mode.

DOS/Windows

Get a Linux distro or go to the nearest Apple Store.

Or figure it out yourself.

Ongoing Work

  • Always begin your day by pulling the latest revisions from GitHub

Developer notes