Code Monkey home page Code Monkey logo

cloud-auth-api's Introduction

Cloud Auth API

This is an API built with Express, Prisma and TypeScript which aims to replace our self-hosted Supabase GoTrue instance.

Prerequisites

To run this API, you will need:

  • Node.js (version 16 or higher)
  • npm

Getting Started

  1. Clone this repository to your local machine.
git clone https://github.com/WalletConnect/cloud-auth-api.git
  1. Install the dependencies.
cd cloud-auth-api
npm install
  1. Set up your environment variables
cp .env.example .env
  1. Set up Prisma
npx prisma generate

// optionally, you can run Prisma Studio
npx prisma studio
  1. Start the development server.
npm run dev

The server will start on port 3333. You can access it at http://localhost:3333.

  1. Alternatively you can run the docker containers
docker-compose build && docker-compose up

API Endpoints

This API has the following endpoints:

  • GET /nonce - Gets a nonce.
  • POST /connect - Creates a new user along with a session, an identity and gerenates access and refresh tokens. If the user already exists, it'll get updated and new access and refresh tokens will be generated.

Health checks

cloud-auth-api's People

Contributors

arein avatar cali93 avatar harryet avatar jonathanconn avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

Forkers

md10inoffun

cloud-auth-api's Issues

Add tests and improve CI/CD

Problem

This service is missing tests making it difficult to spot bugs when making changes.
We also need the ability to deploy to staging and validate the staging deployment before releasing to prod.

Support Scaling

Nonces are stored in sessions which are memory based meaning if two instances are spun up to deal with load there is a potential that it would go to different instances each time. For now I have disabled scaling to counter this but it should be fixed as scaling is an operation readiness requirement

Monitoring

Grafana dashboard with operational metrics as well as others e.g. how many nonces, how many registered accounts, etc

Dashboard should also show HTTP stats and could be linked into the Cloud App's Dashboard?

Deploy the API to AWS ECS

Context

This API needs to be deployed on AWS ECS.
We need 2 environments:

  • staging
  • production

Environment variables can be found in .env.example

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.