Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sametcodes/readme.rocks
Visualize your development statistics and metrics.
https://github.com/sametcodes/readme.rocks
developer statistics
Last synced: 11 days ago
JSON representation
Visualize your development statistics and metrics.
- Host: GitHub
- URL: https://github.com/sametcodes/readme.rocks
- Owner: sametcodes
- Created: 2022-11-01T11:19:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T13:59:54.000Z (4 months ago)
- Last Synced: 2024-12-12T12:48:42.568Z (15 days ago)
- Topics: developer, statistics
- Language: TypeScript
- Homepage: https://readme.rocks
- Size: 6.42 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
[](milestone/3)
## Sponsors and goals
### Running locally
Make sure you install the dependencies first.
```bash
npm install
```
You need the `.env` file that have environment variables. You can get it from the [Vercel](https://vercel.com) 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.
```bash
npm run prepare
```
```bash
npm run prisma:generate
```
You are ready to go to run the development server.
```bash
npm run dev
```
Good hacking.
### Code linting and prettifying
This project uses [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) for code linting and formatting. You can run the following command to lint the code and check if there are any errors.
```bash
npm run lint
```
If you want to fix the errors automatically, you can run the following command.
```bash
npm run lint:fix
```
### Commit linting
This project uses [Husky](https://typicode.github.io/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](https://www.conventionalcommits.org/en/v1.0.0/#specification).
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.
```bash
npm run migrate:platform
```
## Versions and changelogs
Please check the [releases page](https://github.com/sametcodes/devstats/releases) to see the versions and changelogs.