Skip to content

palmapp-xyz/api-server

Repository files navigation

Palm API Server

This project contains the server for the Palm project based on firebase services.

Firebase services

Palm backend is based on the following firebase services:

Project structure

The project is structured as follows:

  • functions contains the cloud functions
    • src contains the source code
      • api contains the api moralis evm proxy routes generator
      • pofile contains the users profile management routes
      • stream contains the stream routes
      • utils contains the utility files of functions
      • index.ts contains the main entry point of the functions
    • test contains the tests
  • hosting contains the static files for the hosting
  • extensions contains the firebase extensions

Prerequisites

To start the project you need to have the following installed:

How to start

  1. Clone the project
  2. Install the dependencies with per module 3. For functions 4. cd functions 5. yarn install 6. cp .env.example .env 7. add the values in .env 8. cd ..
  3. Login to firebase with firebase login using your Google account (you need to be a member of the project oedi-a1953)
  4. Select the project with firebase use oedi-a1953
  5. Deploy the project with
    • if you want to deploy all the services firebase deploy
    • if you want to deploy only function firebase deploy --only functions
    • if you want to deploy only hosting firebase deploy --only hosting
    • if you want to deploy only extensions firebase deploy --only extensions

Run locally

To run the project locally using the firebase emulators firebase emulators:start

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published