README.md

readme.rocks

All your statistics at once.

Your development metrics

Recent projects and used languages

Project progress with milestones

Line stats

Calendar and streaks

Your latest daily.dev and dev.to articles

Contributors

Milestones

Sponsors and goals

Running locally

Make sure you install the dependencies first.

npm install

You need the .env file that have environment variables. You can get it from the Vercel project settings, or just by running vercel env pull .env command if you have the access to the vercel project. If you don't have, ask admin to get it.

Before running, you need to generate the database schema and prepare husky hooks.

npm run prepare

npm run prisma:generate

You are ready to go to run the development server.

npm run dev

Good hacking.

Code linting and prettifying

This project uses ESLint and Prettier for code linting and formatting. You can run the following command to lint the code and check if there are any errors.

npm run lint

If you want to fix the errors automatically, you can run the following command.

npm run lint:fix

Commit linting

This project uses Husky to run the linting and formatting before every commit. If commits do not fit the conventional commit format, the commit will be rejected. Check the rules here.

Here are possible commit headers with descriptions. Choose the one that fits the changes you made.

build: Changes related to the build system or external dependencies, such as updating a build script or adding/removing a package.
config: Changes related to the configuration of the application, such as updating environment variables, modifying configuration files, or adjusting settings that alter the behavior of the application.
docs: Updates or additions to the documentation, such as user guides, API documentation, or code comments.
feat: New features or enhancements that add functionality to the application.
fix: Bug fixes or patches that address issues in the codebase.
perf: Performance improvements or optimizations, such as code refactoring to enhance execution speed or memory usage.
refactor: Code changes that neither fix a bug nor add a feature but improve code quality, readability, or maintainability.
revert: Reverting a previous commit or change, effectively undoing the changes made in that commit.
style: Cosmetic changes to the code that do not affect its functionality, such as fixing indentation, removing whitespace, or updating code formatting.
test: Changes related to testing, such as adding, updating, or removing test cases or updating testing frameworks.
security: Changes related to security, such as fixing vulnerabilities or adding security features.

Scripts

The metric methods require name and descriptions on the database records, and they are provided on as JSDoc comments on the methods. You can run the following command to migrate metric methods to the related database records.

npm run migrate:platform

Versions and changelogs

Please check the releases page to see the versions and changelogs.