Git Product home page Git Product logo

mbds-project-skeleton's Introduction

2024 MBDS project PixelBoard

Introduction

this is a mono-repo project for the 2024 MBDS project PixelBoard. It contains the following packages:

  • client: the frontend of the project
  • api: the backend of the project

You can use this skeleton to start your project.
You have to edit the root package.json file :

  • replace the name property (replace xxxx by the first letter of each member of your group)
  • set the repository by setting the url of your project

Installation

To install the project, you need to clone the repository and install the dependencies. You can do this by running the following commands in the root directory of the project:

yarn

Usage

To start the project, you need to run the following commands in the root directory of the project (in two separate terminals):

yarn start:client 

call start script in ./packages/client package.json (to start the react client)

yarn start:api 

call start script in ./packages/api package.json (to start the api)

Adding libraries

If you want to add library you can use the following commands (in the root directory of the project) :

yarn workspace <client|api> add <package-name> 

For example to add express to the api package you can run:

yarn workspace api add express

For example to add a librairy for devDependencies to the client package you can run:

yarn workspace client add -D <package-name>

mbds-project-skeleton's People

Contributors

francois06 avatar

Watchers

Hugo Mallet avatar  avatar

Forkers

pandashad

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.