Nuxt/README.md
pooya parsa de17f1388c
chore: add contribution docs to the repository (#435)
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
Co-authored-by: Daniel Roe <daniel@roe.dev>
2021-09-10 09:19:33 +02:00

61 lines
1.8 KiB
Markdown

<h1>
<img src="./.github/logo.svg" >
</h1>
<p>
<a href="https://github.com/nuxt/framework/actions?query=branch%3Amain+event%3Apush"><img src="https://github.com/nuxt/framework/workflows/ci/badge.svg?branch=main&event=push" alt="CI Status"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/dm/nuxt3" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/v/nuxt3" alt="Version"></a>
<a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/license/nuxt3" alt="License"></a>
<a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
</p>
Welcome to Nuxt3 repository ✨
<table>
<tbody>
<tr>
<td>
<h2>📖 Documentation</h2>
<p>
Read <a href="https://v3.nuxtjs.org">Online Docs</a> here!
</p>
</td>
<td>
<h2>🐞 Reporting bugs</h2>
<p>
Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Reporting Bugs</a> page </p>
</td>
</tr>
<tr>
<td>
<h2>💡 Suggestions </h2>
<p>
Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Contribution</a> page
</p>
</td>
<td>
<h2>❔ Questions</h2>
<p>
Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Getting Help</a> page
</p>
</td>
</tr>
</tbody>
</table>
## 👀 Private beta
We are currently in private beta in order to stabilize the framework before opening to the whole community.
Please take a look at the [beta discussion](https://github.com/nuxt/framework/discussions/434) for further information.
## 💻 Development
- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Install dependencies with `yarn install`
- Run `yarn stub` to activate passive development
- Open playground with `yarn play`