🦊 Users API Project

A simple rest api for users.

About the project   |    Technologies   |    Getting started   |    Docs   |    How to contribute   |    License

📊 About the project

Users back-end app built with TypeScript, Drizzle a ElysiaJS.

🔥 This project aims to keep runtime agnostic, this means it should work on Bun, Node or any Web Standard API compatible runtime.

🚀 Technologies

Technologies that I used to develop this api

• Bun
• Elysia
• Drizzle
• PostgreSQL
• JWT
• Swagger
• Docker
• Eslint

💻 Getting started

Requirements

• Bun
• One instance of PostgreSQL

Obs.: I recommend to use docker

Clone the project and access the folder

$ git clone https://github.com/dudubernardino/laionpedia-api && cd laionpedia-api

Follow the steps below

# Install the dependencies
$ bun install

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Create the instance of postgreSQL using docker compose
$ docker compose up -d

# To finish, run the api service
$ bun dev

# Well done, project is started!

📚 Docs

I used swagger to document the API. You can access /docs.

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork dudubernardino/bun-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd bun-api

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

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

---

Made with ❤️  by Eduardo Bernardino 👋  See my linkedin