Git Product home page Git Product logo

api-crud-node-js-with-express-firebase's Introduction

Perfeito, aqui está o README atualizado com a licença MIT:


API CRUD Node.js with Express and Firebase

This is a simple CRUD (Create, Read, Update, Delete) API built with Node.js, Express, and Firebase.

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/seu-usuario/api-crud-node-express-with-firebase.git
  2. Install dependencies:

    cd api-crud-node-express-with-firebase
    npm install
  3. Set up Firebase:

    Create a Firebase project and obtain your Firebase credentials.

    Then, create a file named firebase.ts inside the firebase folder with the following content:

    // Import the functions you need from the SDKs you need
    import { initializeApp } from "firebase/app";
    
    // Your web app's Firebase configuration
    const firebaseConfig = {
      apiKey: "YOUR_API_KEY",
      authDomain: "YOUR_AUTH_DOMAIN",
      projectId: "YOUR_PROJECT_ID",
      storageBucket: "YOUR_STORAGE_BUCKET",
      messagingSenderId: "YOUR_MESSAGING_SENDER_ID",
      appId: "YOUR_APP_ID"
    };
    
    // Initialize Firebase
    const app = initializeApp(firebaseConfig);
    
    export default app;

    Replace YOUR_API_KEY, YOUR_AUTH_DOMAIN, YOUR_PROJECT_ID, YOUR_STORAGE_BUCKET, YOUR_MESSAGING_SENDER_ID, and YOUR_APP_ID with your Firebase credentials.

  4. Start the development server:

    npm run dev

    Your API should now be running at http://localhost:5050.

Available Scripts

  • npm run dev: Starts the development server using tsx to watch for changes in TypeScript files.
  • npm start: Starts the server using Node.js.
  • npm run build: Builds the TypeScript files.
  • npm test: Runs tests (not implemented in this project).

Dependencies

  • Express: Fast, unopinionated, minimalist web framework for Node.js.
  • Firebase: Firebase SDK for JavaScript.
  • Firebase Admin SDK: Firebase Admin Node.js SDK.
  • uuid: Simple, fast generation of RFC4122 UUIDs.

Dev Dependencies

License

This project is licensed under the MIT License. See the LICENSE file for details.


Make sure to replace the values for YOUR_API_KEY, YOUR_AUTH_DOMAIN, YOUR_PROJECT_ID, YOUR_STORAGE_BUCKET, YOUR_MESSAGING_SENDER_ID, and YOUR_APP_ID with your actual Firebase credentials. This README provides clear instructions on how to configure and start the project, as well as information about available scripts, dependencies, and licensing.

api-crud-node-js-with-express-firebase's People

Contributors

miguelhp373 avatar

Watchers

 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.