Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add init markdown starter doc #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions init.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<p align="center">
<a href="https://adonisjs.com/" target="_blank"><img src="https://avatars.githubusercontent.com/u/13810373?s=200&v=4" width="120" alt="AdonisJS Logo" /></a>
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@adonisjs/core" target="_blank"><img src="https://img.shields.io/npm/v/@adonisjs/core.svg" alt="NPM Version" /></a>
<a href="https://github.com/adonisjs/core" target="_blank"><img src="https://img.shields.io/github/license/adonisjs/core.svg" alt="License" /></a>
<a href="https://github.com/adonisjs/core" target="_blank"><img src="https://img.shields.io/github/stars/adonisjs/core.svg" alt="Stars" /></a>
<a href="https://discord.gg/vDcEjq6" target="_blank"><img src="https://img.shields.io/discord/423256550564691970.svg?logo=discord" alt="Join Discord" /></a>
<a href="https://docs.adonisjs.com" target="_blank"><img src="https://img.shields.io/badge/docs-Documentation-blue" alt="Documentation" /></a>
</p>

## Description
**AdonisJS** is a TypeScript-first web framework for building web apps and API servers. It comes with support for testing, modern tooling, an ecosystem of official

### 📚 [AdonisJS Documentation](https://docs.adonisjs.com)

## Run and Build
```bash
# development mode
npm run dev

# production mode
npm start

# build for production
npm run build
```

## Run tests
```
npm run test
```

## Deployment

For detailed deployment instructions, refer to the [AdonisJS Deployment Guide](https://docs.adonisjs.com/guides/getting-started/deployment#deployment).