Welcome to the user manual for 3Squared - Train App! This document is intended to provide you with all the information you need to get started with and use the software effectively. This is a tool to track the UK rail Network. This user guide will help you make the most out of your experience.
git clone https://github.com/sammo-2000/software-project [NAME]
.env Content will be found in the submission
cd [NAME]/server
mkdir .env
cd [NAME]/client
mkdir .env
In both terminals, this will install the node modules
npm i
To start running the project in development mode please type cmd below in both terminals
npm start
If your styles does not look correct, please run following code in client terminal
npm run tailwind
Open your web browser and navigate to http://localhost:3000 to view the project.
We'd like to extend our gratitude to the contributors who dedicated their time and effort to this project. Below are the GitHub links and names of everyone involved:
Please be informed that this project was developed by students at Sheffield Hallam University as part of an assessment. The project involved collaborating with a real client to understand their needs and requirements, and subsequently developing the necessary application.
The API utilized in this project is owned and managed by 3Squared. It's worth noting that the API may be taken down in the future. Therefore, if you're viewing this repository at a later date, the application may no longer be functional. For a demonstration of the working application, please visit https://www.youtube.com/watch?v=Ri1bly5Mv8M.