Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.63 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.63 KB
Raw

##San Francisco In Progress

How to Run SF in Progress locally

Clone the repo from your command line

git clone [email protected]:jmcelroy5/SF-in-Progress.git

Change to the directory SF-in-Progress

cd SF-in-Progress

Install the npm libraries

npm install

Bundle React files

npm run reactbuild

Open a new tab and start the server

npm start

Open your browser and navigate to localhost:5000/ or localhost:5000/map

Contributing to SF In Progress

About the Project

SF In Progress is an open source project with the goal of creating more awareness and educating SF citizens on new housing development issues the city is facing. Because this is a volunteer based project we would like to keep the tech stack as short and simple as possible, we are currently using the following technologies:

  • Plain HTML + CSS
  • Node.js for server and dependency management
  • React.js to render the Map Page of San Francisco Properties
  • MongoDB for data storage
  • MapBox API for map tile and leaflet API.

Any additions to the tech stack should first be discussed and agreed upon by project contributors as a group to keep it as newcomer friendly as possible.

Getting Started

To get started, simply fork the project and follow the above instructions to setup a local development environment.

What to Work On

We use Trello to keep track of bugs/new features we want to implement. Please e email (some@email) to get an invite and pick an issue you would like to work on.

Submitting Changes

  1. Fork the project
  2. Create a topic branch.
  3. Implement your feature or bug fix
  4. Commit and push your changes
  5. Submit a pull request.

Thanks for reading!