Simulation about how the Rovers can move through a grid after a sequence of orders were given to them.
- Clone this repository and cd to the newly create folder
> git clone https://github.com/byverdu/mars-rover.git
> cd mars-rover
- Change the scripts folder permissions so you can execute the scripts
> chmod +x scripts/*
- Run the
setup.sh
script
> ./scripts/setup.sh
You must have installed Docker and NodeJs. You need to use a Unix-like operating system.
Docker must be running before you execute the install script
Execute the install script that will bootstrap the project and install all the needed dependencies on your system.
# lerna bootstrap && yarn tsc
> ./scripts/install.sh
Create the docker images and start the containers by running the following command
> docker-compose up --build
Once docker has finished, the API will be running on port 9000 and the UI on port 3000
Previous running the tests all the npm packages must have been installed
# from the root project folder
> yarn test
# from the root project folder
> cd packages/api
> yarn test:api
# from the root project folder
> cd packages/client
> yarn test:client
- NodeJs - Javascript runtime environment
- Typescript - Type superset of Javascript
- Lerna - JavaScript projects manager
- ExpressJs - The web framework used
- Mongoose - Mongodb object modeling for nodeJs
- React - JavaScript library for building user interfaces
- SCSS - CSS pre-processor
- Jest - Testing framework
- Albert Vallverdu - Initial work - @Byverdu
This project is licensed under the MIT License - see the LICENSE.md file for details