This web-based app that allows users to view data from journeys made with city bikes in the Helsinki Capital area. The platform will have both a user interface (UI) and a backend service. The UI allows users to upload large datasets or add individual Journeys and Stations Node.js, React, Typescript, React Query, Leaflet, Postgres, Sequelize and Tailwind.
Journey Features • Station Features • Single Station Features • How To Use • Credits • Description • License
- Import journey data from the CSV files
- Validate data before importing
- Journey list view: Pagination, Searching, Ordering per column
- For each journey show departure and return stations, covered distance in kilometers and duration in minutes
- Easily extendable to show more columns
- UI for adding additional journeys
- e2e tests
- Import station data from the CSV files
- Validate data before importing
- Station list view: Pagination, Searching
- For each station show station names and addresses
- Expandable row with Station details
- UI for adding additional stations
- UI for deleting stations
- e2e tests
- Total number of journeys starting from the station
- Total number of journeys ending at the station
- Top 5 most popular return stations for journeys starting from the station
- Top 5 most popular departure stations for journeys ending at the station
- Ability to filter all the calculations per month
- Station location on the map
Everything has been developed and tested on windows 10 pro
Note For Windows only
# Clone this repository
$ git clone https://github.com/tomppatomppa/helsinki-bike-routes.git
# Go to server folder
$ cd helsinki-bike-routes/server
# How to setup local database
# Download and install postgres https://www.postgresql.org/, (don't forget to set the password)
# Login using the command line, <postgres> is the default user unless you specify something else
$ psql -U postgres
# Enter your password when asked
# Create databases
$ CREATE DATABASE mydatabase;
$ CREATE DATABASE testdatabase;
# Confirm they exist by running
$ \l
# Create a .env file in the /server folder with the following contents
# local database connection string should look something like this.
$ DATABASE_URL='postgres://postgres:<password>@localhost:5432/mydatabase'
$ TEST_DATABASE_URL='postgres://postgres:<password>@localhost:5432/testdatabase'
# Install dependencies
$ npm install
# Run script to create a client build. This will create a production build of the client and and start the server at port 3001
$ npm run build:dev
# Open browser
$ http://localhost:3001/
# Or run the client seperately by going to /client folder and run
$ npm install
$ npm run dev
# Populate the database with small a small dataset found in station.csv and journey.csv found in /client/data folder
# Press menu icon in the app -> Upload File -> /client/data/stations.csv
# Upload File -> /client/data/journeys.csvNote For Windows only
# Go to server folder
$ cd ./server
# Remember to set the TEST_DATABASE_URL in .env file
# Run Server test
$ npm run test
# Run individual test files by changing <testfile.js>.test.js to your preferred test file
# e.g "test:single": "set NODE_ENV=test&& jest --runInBand --silent --testPathPattern=isFloat.test.js",
$ npm run test:single
Note For Windows only
# Go to client folder
$ cd ./client
# Run client tests
$ npm run test
Note For Windows only
# Start server before running e2e tests
$ cd ./server
$ npm run dev
# Go to client folder and start client before running e2e tests
$ cd ./client
$ npm run dev
# Run client tests in another terminal
$ npm run cy:open-e2e
Client https://github.com/tomppatomppa/helsinki-bike-routes/tree/main/client
Server https://github.com/tomppatomppa/helsinki-bike-routes/tree/main/server
https://bike-routes.herokuapp.com/
MIT
GitHub @tomppatomppa ·