/workshop-web-dev-backend

🧠 Back-end content that I built during the workshop I gave for 42 rio students.

Primary LanguageJavaScript

Workshop Web Dev Back-end


Workshop Web Dev Back-end
Back-end content that I built during the workshop I gave for 42 rio students.

Created by Gabriel de Jesus.

📚 Notes

  • What is an API?
    An interface that allows communication between different systems.
    
  • What is REST in the API context?
    An architectural pattern that can be used to build APIs.
    
    REST has 6 levels:
      1. Uniformity
      2. Decoupling
      3. Statess
      4. Cache
      5. Layer architecture
      6. Code on demand
    
    Some benefits of the REST standard:
      1. Standardization
      2. Easy
        2.1. Usage
        2.2. Consumption
        2.3. Maintenance
    
  • What is a RESTful API?
    It is an API that meets the 6 levels of the REST standard.
    

🚀 Quick Start

Clone repository

git clone https://github.com/gabrieldejesus/workshop-web-dev-backend
cd workshop-web-dev-backend

Install dependencies

npm install

🦾 Development

To start the project locally on development, run:

npm run dev

Open http://localhost:3030 with your client to see the result.

📜 Documentation

🚨 Requirements

  • Node.js >= 16

🗂️ Directory Structure

  • public — Static assets such as images, and others files.
  • src — Application source code.

🦾 Scripts

  • npm run dev — Starts the application in development mode at http://localhost:3030.

🐞 Bugs, help, issues or new updates

If you need any help tu run this app or want to make new updates just contact me at: hi@gabrieldejesus.dev