Git Product home page Git Product logo

onacut's Introduction

onacut237

Project setup backend

REQUIREMENTS

  • python (3.x recommended) & pip (>= 22 recommended)
  • docker
  • make (a command line tool to run Makefile commands)

HOW TO SET UP

# Put appropriate parameters inside .env.example
make install-deps

HOW TO LAUNCH

DEV
make run

# To run tests
make test

# formating
make lint
PROD

Or Using Docker

# This will install and run your project on port 8000
make docker-run

To run the backend [fastapi]

  • Install the virtualenv

  • Run the backend

make run

Project setup frontend

REQUIREMENTS

  • node & npm
  • docker
  • make (a command line tool to run Makefile commands)

HOW TO SET UP

# Put appropriate parameters inside .env.example
make install-deps

# or with npm
npm install

HOW TO LAUNCH

DEV
make run

# or with npm
npm start

# To run tests
make test
PROD

Or Using Docker

make serve

# or with npm
npm run serve

# This will install and run your project on port 3000
make docker-run

To launch the frontend, we need Node installed and npm

  • Install the dependencies
npm install

Compiles and hot-reloads for development

npm run start 

Compiles and minifies for production

npm run build

NB: To launch the frontend, you should launch the backend first.

Screenshots

Illustrative video of the project

simplescreenrecorder-2022-08-15_10.40.49.mp4

onacut's People

Contributors

arsenkhy avatar asam237 avatar elhmn avatar godsakani avatar mouafus avatar sanix-darker avatar stefmedjo avatar yokwejuste avatar zaker237 avatar

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.