Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jkytoela committed Feb 24, 2021
1 parent ae65ce2 commit bdc71a4
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
TODO
<p align="center">
<img src="public/screenshot.png" alt="Screenshot">
</p>

<p align="center">
<img src="https://img.shields.io/static/v1?label=PRs&message=welcome&style=for-the-badge&color=24B36B&labelColor=000000" alt="PRs welcome!" />

<img alt="License" src="https://img.shields.io/github/license/jpedroschmitz/typescript-nextjs-starter?style=for-the-badge&color=24B36B&labelColor=000000">
</p>
<br>

A free Next.js TypeScript landing page template for SaaS products, online services and more.

-**Next.js** — The React Framework
- 🔥 **next-seo** — Manage SEO easily
- 💡 **twind** — The smallest, fastest, most feature complete Tailwind-in-JS solution in existence
- 📏 **ESLint** — Pluggable JavaScript linter
- 💖 **Prettier** — Opinionated Code Formatter
- 🐶 **Husky** — Use git hooks with ease
- 📄 **Commitizen** — Conventional commit messages CLI
- 🚓 **Commitlint** — Lint commit messages
- 🖌 **Renovate** — Dependency update tool
- 🚫 **lint-staged** — Run linters against staged git files
- 🗂 **Absolute import** — Import folders and files using the `@` prefix

## 🚀 Getting started

Easiest way to get started is to [click here](https://github.com/jkytoela/next-startd/generate).

Run the following commands inside the project folder:

1. `yarn`;
2. `yarn dev`;

To view the project open `http://localhost:3000`.


## 🤝 Contributing

1. Fork this repository;
2. Create your branch: `git checkout -b my-new-feature`;
3. Commit your changes: `git commit -m 'Add some feature'`;
4. Push to the branch: `git push origin my-new-feature`.

Consider contributing to the original TypeScript Starter, which you can find [here](https://github.com/jpedroschmitz).

**After your pull request is merged**, you can safely delete your branch.

## 📝 License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.
Binary file added public/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bdc71a4

Please sign in to comment.