Pizza Shop

An order and presentation web application for an hypothetical pizzeria

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Authors
• License

---

About The Project

This is a school project made at Polytech Annecy-Chambéry as part of the FullStack course

Built With

• Express
• Lerna
• TypeScript
• Jest

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The following softwares are needed to run the projet

• Node 12
• yarn (npm may cause issues)
• MongoDB

Installation

1. Clone the repo

git clone https://github.com/nowtryz/PizzaShop.git

2. Install packages

yarn            # downloads dependencies for the root project
yarn bootstrap  # links packages with common

3. Update .env files with your values

Usage

• Run the project

yarn dev:start

• Or build the prod version

yarn build
yarn start

Roadmap

See the Roadmap on Notion for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

• Damien Djomby - Nowtryz
• Adrien Simard - adrien-simard

Project Link: https://github.com/nowtryz/PizzaShop

License

This project is licensed under the MIT License - see the LICENSE.md file for details