Skip to content

almond-hydroponics/almond-web

Repository files navigation

almond

CI CircleCI Maintainability Test Coverage Known Vulnerabilities

Musings sphere to share amazing ideas and articles with the rest of the world.

Almond

Simple but complicated almond

Description

This application will be used in a hydroponics farm control system to be used at home with limited space, in greenhouses and indoors as well.

This is a Next.js project bootstrapped with create-next-app .

Development set up

  1. Install Node JS.
  2. To clone, run git clone https://github.com/mashafrancis/almond-re.
  3. cd into the root of the project directory.
  4. Install yarn.
  5. Run yarn install on the terminal to install dependencies.
  6. Create a .env file in the root directory of the application. Example of the content of a .env file is shown in the .env.example
  7. Setup local development server.
  • Save changes and quit the editor.

Development server

Run yarn dev for a dev server. The app will automatically reload if you change any of the source files.

Build

Run yarn build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run yarn test:unit to execute the unit tests. This is achieved through the use of jest package which is used to test javascript code .

Running end-to-end tests

Run yarn cypress:open to execute the end-to-end tests via Cypress.

Others

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Author