waveyboym / COS-214-Project

A restaurant simulation application that makes use of various design patterns. implemented in C++ by {{NULL}}_Exceptions

COS-214-Project

Table of Contents

• COS-214-Project
  • Table of Contents
  • Summary
  • Contributing
  • Building
    • Building from the command line with a Linux based OS(Debian, Ubuntu and Fedora) automatically
    • Building from the command line with a Linux based OS(Debian, Ubuntu and Fedora) manually
    • Building from the command line with windows OS
    • Building with visual studio code
  • Contributors

Summary

A restaurant simulation application that makes use of various design patterns. implemented in C++ with a ReactJS frontend.

Contributing

Please have a look at CONTRIBUTING.md for more details on contributing to this repo

Building

Building from the command line with a Linux based OS(Debian, Ubuntu and Fedora) automatically

1. Open a new terminal
2. Download this bash file
3. Run the bash script in your terminal and watch the magic happen ✨
4. Then open another terminal and from the root of this project run

cd COS-214-PROJECT/src/frontend

5. Run

npm install

6. Run

npm start

Building from the command line with a Linux based OS(Debian, Ubuntu and Fedora) manually

1. Open a new terminal
2. Run

sudo apt-get install libgtest-dev

3. Run

sudo apt-get install cmake

4. Follow this guide to download and install boost
5. Clone this repo
6. Open a new terminal where you cloned this repo to and run

cd COS-214-PROJECT/src

7. For Release(no unit tests, with gui), run

cmake -DCMAKE_BUILD_TYPE=Release -S . -B build

8. For Debug(google unit tests, with no gui), run

cmake -DCMAKE_BUILD_TYPE=Debug -S . -B build

8. Run

cmake --build build

9. For Release(no unit tests, with gui), run

cd build && ./main

10. For Debug(google unit tests, with no gui), run

cd build && ctest

11. If you are in debug, skip steps 12 to 14
12. Then open another terminal and from the root of this project run

cd COS-214-PROJECT/src/frontend

13. Run

npm install

14. Run

npm run dev

15. If any build files are generated on your local machine, please do not commit them. Rather create a .gitignore file in the build directory and add an asterik(*) to it.
16. For a more detailed tutorial on cmake, follow this link

Building from the command line with windows OS

1. Before we start, make sure you have a c++ compiler installed on your system. If not download and install one.
2. Download and install cmake
3. Download boost for windows zip file.
4. Unzip the zip file
5. Create a folder named Boost under C:\Program Files
6. In that folder, paste the contents from the unzipped file
7. Navigate to boost_<version number>\boost_<version number>\tools\build and open a terminal there
8. run

.\bootstrap.bat gcc

9. run the command below or the command boost tells you to run

.\b2.exe install

10. run

cd ../../

11. run

.\bootstrap.bat gcc

12. run

b2 --build-dir="C:\Program Files\Boost\boost_<version number>\boost_<version number>\build" --build-type=complete --prefix="C:\<location to where you want boost to be goes here>\boost" toolset=gcc install

13. In your systems path variables, add C:\<location where you placed boost goes here>\boost\include\boost-1_80 and C:\<location where you placed boost goes here>\boost\lib
14. Clone this repo
15. Open a new terminal where you cloned this repo to and run

cd COS-214-PROJECT/src

16. For Release(no unit tests, with gui), run

cmake -DCMAKE_BUILD_TYPE=Release -S . -B build

17. For Debug(google unit tests, with no gui), run

cmake -DCMAKE_BUILD_TYPE=Debug -S . -B build

18. Run

cmake --build build

19. For Release(no unit tests, with gui), run

cd build && ./main

21. For Debug(google unit tests, with no gui), run

cd build && ctest

22. If you are in debug, skip steps 11 to 13
23. Then open another terminal and from the root of this project run

cd COS-214-PROJECT/src/frontend

24. Run

npm install

25. Run

npm run dev

26. If any build files are generated on your local machine, please do not commit them. Rather create a .gitignore file in the build directory and add an asterik(*) to it.
27. For a more detailed tutorial on cmake, follow this link

Building with visual studio code

1. Download and install C++ build tools by following this tutorial
2. Download and install boost for your operating system.
3. Download and install cmake
4. Clone this repo
5. Download and install visual studio code
6. Download and install cmake tools from the visual studio marketplace
7. Add the folder COS-214-Project to a new work space in visual studio or open with code from your file manager.
8. Wait for VS code to initialize and set itself up(it may add some files under the build folder)
9. At the bottom of Visual Studio code, you should see a play button, click it and the project should build and run.
10. Specify the build type(Release or Debug) by clicking and changing it.
11. If you are in debug, skip steps 12 to 14
12. Then open another terminal and from the root of this project run

cd COS-214-PROJECT/src/frontend

13. Run

npm install

14. Run

npm run dev

15. For a more detailed tutorial on cmake, follow this link
16. Alternative tutorials:
    • https://code.visualstudio.com/docs/cpp/cmake-linux
    • https://www.youtube.com/watch?v=sc6_86jgQls&ab_channel=TechHara

Contributors

Thanks to these wonderful people for their contributions.

Profile	Username	Personal Website	Role	Bio
	Michael	waveyboym	Tech Lead, Software developer, Software architect, UI/UX Engineer	interested in computer science and creating fun CS related projects
	Carey	cmokou	Software developer, UI/UX Engineer, Business analyst	the picasso of web design and interested in exploring the world of computer science :)
	Lunga	Remiku-bit	Engineering Manager, Software developer, Business analyst	To me, programming is more than an important practical art. It is also a gigantic undertaking in the foundations of knowledge.
	Jaden	Jaden Moodley	Software developer, QA engineer, Tester	Likes game dev and interesting app ideas
	Jaide	JMPastoll	Software developer, Business analyst	Interested in game dev and currently craving sleep
	Linda	LOK3LANI	Software developer, Business analyst	Has a talent for frontend but majorly interested in the guts of most projects
	Nicholas	NicholasJHarvey	Software developer, Tester	Very interested in programming, with a focus on backend development