https://github.com/alenvelocity/aureolin-starter

Starter Project for Aureolin
https://github.com/alenvelocity/aureolin-starter

api decorators esnext koa node rest typescript

Last synced: 3 months ago
JSON representation

Starter Project for Aureolin

• Host: GitHub
• URL: https://github.com/alenvelocity/aureolin-starter
• Owner: AlenVelocity
• Created: 2021-10-12T12:17:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-04T14:39:05.000Z (over 4 years ago)
• Last Synced: 2025-10-23T21:41:56.703Z (8 months ago)
• Topics: api, decorators, esnext, koa, node, rest, typescript
• Language: TypeScript
• Homepage: https://aureolin-starter-production.up.railway.app/
• Size: 335 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


# Aureolin Starter

Starter Project for Aureolin

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FAlenSaito1%2FAureolin-starter&referralCode=ZELDAAA)

[![Discord](https://img.shields.io/discord/898177582829285387?label=Discord&style=flat-square)](https://discord.gg/3Pg2Nw2vjn) [![CodeFactor](https://img.shields.io/codefactor/grade/github/alensaito1/aureolin-starter?style=flat-square&label=Code%20Quality)](https://www.codefactor.io/repository/github/alensaito1/aureolin-starter) [![NPM](https://img.shields.io/npm/dw/aureolin?style=flat-square&label=Downloads)](https://npmjs.com/package/aureolin)[![Prettier](https://img.shields.io/badge/Code_Style-Prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)



## 🟦 Demo

### Deployed on Railway ([Visit](https://aureolin-starter-production.up.railway.app/))

## 🟨 Introduction

This is a starter project for Aureolin. Aureolin is an open source project that aims to provide a simple and easy to use framework for creating web applications.

## 🟥 Features

* 🟦 Wrriten in [TypeScript](https://www.typescriptlang.org/)

* 🟪 [ESLint](https://eslint.org/) Integration

* 🟩 [Prettier](https://prettier.io/) Integration

* 🔳 Hot Restart (Powered by [Nodemon](https://npmjs.com/package/ts-node) and [TS-Node](https://npmjs.com/package/nodemon))

## 🟩 Project Structure

```

├── .eslintignore

├── .eslintrc.js

├── .gitignore

├── .prettierrc

├── .aureolin.config.js

├── .package-lock.json

├── .package.json

├── README.md

├── tsconfig.json

├── src

│   ├── main.ts

│   ├── common

│   │   └── Types.ts

│   ├── components

│   │   ├── Aureolin.tsx

│   │   └── Head.tsx

│   ├── controllers

│   │   ├── HelloController.ts

│   │   └── HomeController.tsx

│   ├── middlewares

│   │   └── AureolinX.ts

│   └── providers

│       └── HTTPProvider.ts

```

---