Code Monkey home page Code Monkey logo

chirpy's Introduction

Chirpy

Chirpy is a monolith REST API written in go that acts as a messaging platform

The frontend

The frontend can be accessed under /apps will be compiled from the root directory

Admin

Accessable under /admin

Metrics

You can see the number of times a Chirp has been read only as a GET request

The backend

Everything here will be accessed under /api

GET Requests

Health

Accessable under /healthz This will tell you if the server is up

/Reset

This will reset the metrics

/Chirps

This will return all the chirps on the server

/Chirps/{chirpID}

This will return the chirp with that specific id

/Reset

This will reset your database

POST Requests

/Chirps

This will create a chirp

/Users

This will create a user

/Login

This will return a Refresh and Access Token

/Refresh

Takes a refresh-token as input, it returns a new access token

Revoke

Takes a Refresh Token as input and revokes it

Webhook

Polka

This is a POST Request and takes a body like this

{
    "event": "user.upgraded",
    "data": {
        "user_id": 3
    }
}

PUT Requests

/Users

This updates the user

DELETE Requests

/Chirps/{chirpID}

deletes the Chirp under chirpID

chirpy's People

Contributors

thegreatestgiant avatar

Watchers

 avatar  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.