Giter Club home page Giter Club logo

project-setup's Introduction

Utils to setup the environment

Getting Started ๐Ÿš€

Prerequisites ๐Ÿ“‹

Setup ๐Ÿ”ง

git clone [email protected]:dei-uc/es2023/pl3.git

After cloning the project, you need to create a .env file in the DEV/frontend like the .env.sample file (copy-paste that file and rename it to just ".env").

VSCode Extensions

These are the extensions that are recommend for VSCode, the first one is the most important.

  • dbaeumer.vscode-eslint
  • usernamehw.errorlens
  • dsznajder.es7-react-js-snippets
  • wix.vscode-import-cost
  • christian-kohler.npm-intellisense
  • mrmlnc.vscode-scss
  • ms-python.python
  • naumovs.color-highlight

Run ๐Ÿ“ฆ

If you are using the Docker app, i recommend to watch this video.
To run the project, you just need to run the following command in the DEV folder:

docker compose up

More commands ๐Ÿ“‹

docker compose exec backend-django sh # Access Django backend container terminal
docker compose exec backend-rails bash # Access Rails backend container terminal
docker compose exec frontend sh # Access frontend container terminal

Inside the django container you can run the following commands:

db:create # Make migrations
db:migrate # Migrate
create:admin # Create superuser (admin)
django # instead of using `python3 manage.py` you can use `django`

Checking Server ๐Ÿ–ฅ๏ธ

Backend should be running on port 8080 and frontend on port 3000.

Testing โš™๏ธ

  • Not possible yet

Built With ๐Ÿ› ๏ธ

  • Docker and Docker Compose
  • Backend
    • Django
    • Rails
  • Frontend
    • Vite - React
    • Sass

project-setup's People

Contributors

curvu avatar joaorbotelho avatar

Stargazers

Josรฉ Rodrigues avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

jrbotelho

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.