https://github.com/djchie/y-combinator-list
A React webapp for displaying Y Combinator companies
https://github.com/djchie/y-combinator-list
Last synced: 8 months ago
JSON representation
A React webapp for displaying Y Combinator companies
- Host: GitHub
- URL: https://github.com/djchie/y-combinator-list
- Owner: djchie
- Created: 2015-09-21T17:37:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-30T11:23:32.000Z (over 10 years ago)
- Last Synced: 2025-01-24T14:48:48.821Z (over 1 year ago)
- Language: JavaScript
- Size: 357 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Y Combinator List Webapp
> A webapp for displaying Y Combinator companies built with React, Node.js, Express, and PostgreSQL. This webapp uses Gulp, Sequelize as an ORM, and Flux for the architecture. Check out the webapp at [y-combinator-companies.herokuapp.com](http://y-combinator-companies.herokuapp.com/)!
## Table of Contents
1. [Usage](#Usage)
1. [Requirements](#requirements)
1. [Development](#development)
1. [Installing Dependencies](#installing-dependencies)
1. [Running Webapp Locally](#running-webapp-locally)
1. [Making Data Changes](#making-data-changes)
1. [Contributing](#contributing)
## Usage
> Easily search for the Y Combinator companies in the search box and slice, dice, and filter out the results via the checkboxes to find the company you're looking for. There's no need to hit a button or press enter to search because the search is done with every keystroke. Click on the website link of your search results to check out the company website or click on the cell to check out the Crunchbase profile for that company.
## Requirements
- Node
- PostgreSQL
## Development
### Installing Dependencies
From within the root directory:
```sh
npm install
```
### Running Webapp Locally
From within the root directory:
```sh
npm run build
npm run start
```
And go to [localhost:8080](http://localhost:8080/)
### Making Data Changes
1. Make the change in the numbers file
1. Convert Numbers to a CSV file
1. Convert CSV file to JSON via [csvjson.com/csv2json](http://www.csvjson.com/csv2json)
1. Copy the JSON data to [data.json](https://github.com/djchie/y-combinator-companies/blob/master/data.json)
1. Set `refreshData` in [app.js](https://github.com/djchie/y-combinator-companies/blob/master/app.js) to `true` to overwrite previous data
1. Run `npm run start`
1. Be sure to `refreshData` in [app.js](https://github.com/djchie/y-combinator-companies/blob/master/app.js) to `false`
### Roadmap
View the project roadmap [here](https://github.com/djchie/y-combinator-companies/issues)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.