Important
You're currently in the backend repository of AurAchieve, written in ExpressJS. To view the flutter frontend, please visit this repository instead.
Fix your damn life.
AurAchieve is the only self-improvement app you'll ever need. Earn Aura for every good thing you do. Prove it with AI, a timer, or just your honesty.
Get it now through GitHub releases.
Warning
These instructions are outdated. They are not being updated regularly as the app is in a early development stage and has breaking changes often.
You'll need NodeJS v22. You may be able to use other versions but this backend was built and tested on v22.17.0. There are no "minimum" requirements for the backend, but it should be fine on just 256MB RAM as its quite lightweight.
- Clone the repository locally
- Install all the packages and dependencies:
npm install- Setup a appwrite project. Enable JWT and email/password based auth. Create a database, with the name
datafor example. Inside it, create 2 collections namedtasksandprofiles. Add the following attributes intotasks:
Add the following in profiles and you'll be done:
-
Generate a API key with database and auth permissions from appwrite and copy it.
-
Download your AurAchieve Firebase project's admin sdk and drop it in a folder named(create new)
privateConfig/ -
Edit
.env.exampleaccording to the details inside it. Rename it to.envafterwards. -
Run.
node server.jsPlease ensure your contributions are compatible with the latest version of the app, but backwards compatibility is appreciated aswell. Follow the Self-Hosting guide to get started!
There's not much about how to contribute yet. Here's how you may make commits:
feat: For new features
improve: For improvement of existing features
fix: For bug fixes
delete: For deleting something
upgrade: For upgrading/updating something, such as dependencies
docs: Anything related to documentation and not to the codebase itself
refactor: When refactoring some part of the codebase.
security: Anything related to the security and safety of the backend. These changes should be compatible with the latest version of the app.
If you appreciate AurAchieve, please sponsor to keep AurAchieve free forever. You can also do this through patreon, but GitHub sponsors is preferred over Patreon as it charges less. This repository could be locked under a sponsorship paywall. However, it is being provided free for everyone. AurAchieve is even licensed under the most open MIT license.
More about sponsorships here.