This program is the client side of the shore computer application. Clients can connect to this web app through the browser and remotely monitor the functions of the boat.
See Stevens-Electrical-Boatworks/shore-server for the server side of the shore computer.
- Next.js
- Prisma
This section will help you download, build, and run the program for development purposes.
Ensure that node.js is installed on your system:
node -v
If it is not, consider checking out a Node version manager such as fnm or nvm. Instructions on how to set up each of them are included in their respective READMEs.
- Clone the repository to your local system:
git clone https://github.com/Dakdot/eboat-client.git
- Install dependencies:
npm install
- Generate Prisma sources:
npx prisma generate
The easiest way to get the program running now is simply to run:
npm run dev
This command uses will automatically restart the server once you make changes to any files which is ideal for development.
To build the server for production, run:
npm run build
To run it, enter the .next/standalone directory and run:
node server.js
Simply run:
docker build .
This repository is set up with some automatic GitHub Actions workflows.
- A Docker image will automatically be built upon every commit.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Thiago Andrade - tandrade1@stevens.edu