Skip to content

Commit

Permalink
Merge pull request #17 from ThinkThread/12-create-project-documentati…
Browse files Browse the repository at this point in the history
…on-website
  • Loading branch information
suphero authored Nov 11, 2023
2 parents 9c9d41a + 6085ed5 commit 90bb35c
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 18 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Contributors

- Muhtalip Dede
- Harun Sokullu
30 changes: 20 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@
[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
[![Known Vulnerabilities](https://snyk.io/test/github/muhtalipdede/avrasya/badge.svg)](https://snyk.io/test/github/muhtalipdede/avrasya)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=bugs)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=muhtalipdede_avrasya&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=muhtalipdede_avrasya)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=bugs)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)
[![CodeFactor](https://www.codefactor.io/repository/github/muhtalipdede/avrasya/badge)](https://www.codefactor.io/repository/github/muhtalipdede/avrasya)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ff4e1c45beb34681b3b4f9946f369c2b)](https://app.codacy.com/gh/muhtalipdede/avrasya/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ThinkThread_avrasya&metric=coverage)](https://sonarcloud.io/summary/new_code?id=ThinkThread_avrasya)

<img src="./images/avrasya.png" alt="drawing" width="200"/>
<img src="./images/avrasya.png" alt="drawing" width="200" style="display: block; margin-left: auto; margin-right: auto; margin-bottom: 20px; border-radius: 10px; box-shadow: 0 0 10px rgba(0,0,0,0.5);" alt="Avrasya Logo"/>

<p align="center">
• <a href="https://avrasya.fly.dev">Official Website</a> •
</p>
Avrasya is a fast and unique Node.js web framework designed for building web applications and APIs. Avrasya stands out with its simple usage, performance, and extensibility.

## Features
Expand All @@ -26,7 +30,6 @@ Avrasya is a fast and unique Node.js web framework designed for building web app
- Extensibility
- Open-source and free


## Getting Started

To get started with Avrasya, follow these steps:
Expand Down Expand Up @@ -99,21 +102,25 @@ See [Example](./examples/file-based-routes) for more details.
To get started with Avrasya, follow these simple installation steps:

1. Clone the Repository:

```bash
git clone https://github.com/muhtalipdede/avrasya.git
```

2. Navigate to the Project Directory:

```bash
cd avrasya
```

3. Install Dependencies:

```bash
npm install
```

4. Start the Application:

```bash
npm run start
```
Expand Down Expand Up @@ -200,11 +207,14 @@ avrasya.router.get("/redirect", (context) => {

Thank you for considering contributing to this project! [CONTRIBUTING](/CONTRIBUTING.md)

## Contributors

Check out the list of contributors in the [CONTRIBUTORS](/CONTRIBUTORS.md) file.

## Issue Template

If you want to report an issue or request a new feature, please use the following template. [ISSUE_TEMPLATE](/.github/ISSUE_TEMPLATE.md)


## License

This project is licensed under the MIT License. For more information, please refer to the [LICENSE](/LICENSE) File.
Expand Down
4 changes: 2 additions & 2 deletions examples/prisma-mongodb/src/prisma/seed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ main()
console.error(e)
process.exit(1)
})
.finally(async () => {
await prisma.$disconnect()
.finally(() => {
prisma.$disconnect()
})
Binary file modified images/avrasya.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 16 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "avrasya",
"version": "1.0.24",
"version": "1.0.25",
"description": "Avrasya is a fast and unique Node.js web framework designed for building web applications and APIs. Avrasya stands out with its simple usage, performance, and extensibility.",
"main": "dist/index.js",
"types": "src/index.d.ts",
Expand Down Expand Up @@ -33,10 +33,22 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/muhtalipdede/avrasya.git"
"url": "git+https://github.com/ThinkThread/avrasya.git"
},
"bugs": {
"url": "https://github.com/muhtalipdede/avrasya/issues"
"url": "https://github.com/ThinkThread/avrasya/issues"
},
"homepage": "https://github.com/muhtalipdede/avrasya#readme"
"homepage": "https://avrasya.fly.dev",
"contributors": [
{
"name": "Muhtalip Dede",
"github": "https://github.com/muhtalipdede",
"twitter": "https://twitter.com/MuhtalipDede"
},
{
"name": "Harun Sokullu",
"github": "https://github.com/suphero",
"twitter": "https://twitter.com/suphero"
}
]
}
5 changes: 3 additions & 2 deletions sonar-project.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sonar.projectKey=muhtalipdede_avrasya
sonar.organization=avrasya
sonar.projectKey=ThinkThread_avrasya
sonar.organization=thinkthread
sonar.sources=src/
sonar.javascript.lcov.reportPaths=/coverage/lcov.info
sonar.coverage.exclusions=/__mocks__/**/*,/__tests__/**/*,/coverage/**/*,/examples/**/*,/node_modules/**/*,jest.config.js

0 comments on commit 90bb35c

Please sign in to comment.