Skip to content

README.md

Latest commit

 

History

History
65 lines (39 loc) · 1.47 KB

README.md

File metadata and controls

65 lines (39 loc) · 1.47 KB

Spatial Calculator API

The Spatial Web App offers comprehensive CRUD functionality, empowering users to effortlessly manage compartment calculations within a browser-based platform. Developed using the MERN stack (MongoDB, Express, React, Node.js), the app prioritizes a web-first approach and integrates responsive design to cater to various screen sizes, including mobile devices.

Folders

The project is divided into three main folders:

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

  • Node.js
  • npm

Installing

A step by step series of examples that tell you how to get a development environment running:

  1. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

  1. Install NPM packages

npm install

  1. Start the server

npm start

  1. Start the frontend
cd spatial-client
npm start

  1. Open the browser and navigate to http://localhost:5173/

  2. Optional: Run the tests

cd test
python -m pytest or python -m pytest -vv

Technologies Used

The tools and frameworks used in this project include: