This repository will be a custom backend template for passcodes. You can use this project or api directly or you can even extend it.
Reference: Custom Backend Docs
Note
There are multiple ways to get started.. or install this server.. look into installation.md file in this repository.
The Github standard process is listed here. (best for developers)
-
Clone The Repository
git clone https://github.com/PasscodesApp/Passcodes-Docs.git
-
Install The Dependency
uv sync
-
Run the API
uv run fastapi dev app/main.py
-
Go to
http://localhost:8000orhttp://127.0.0.1:8000
Important
Currently the project (more or less also me) is not ready for (code) contributions. This project is currently limited by my expertise & I am beginner. Meaning I don;t want others code in my codebase, that I don't understand, I am learning android and will surely learn basic off by start of 2026.. then i will allow the contibution to this repo... But as of now i don't admire code contribution. As I am beginner in android and might have difficuly understand code that not written by me...
There are still other ways to contribute to project.. like by testing app, by contributing to documenation or more or less just by spreading the word around.. about the app. but, code contribution is limited from my side.... & I hope you can understand...
For more, infomation on what kind of contribtuion we approve or allow, please open a issue in our repo. that way you avoid wasteing your time...
By, contributing to project you accept the Terms For Contributions, CONTRIBUTING.md & MIT License.
And also have look at Open Contributing Timeline.
You can ask or discuss casually on our telegram community. But for more important discussion and professional discussion (related to security or major migration doubt), create a thread on github discussion in associated repository. telegram community link or handle will not change.. atleast not that fast...
Important
Also consider our telegram community as single source of truth in any situation.. so please join there!! because other link of website or of github repository might change over time...
Avaliable here in PasscodesApp/Passcodes-Docs.
Passcodes Project is license under MIT License. Downloading Or Use the app or any associated stuff would mean, you are okay and have accepted the license terms.