near / wallet-experience

All epics, issues, and tasks dealing with any Pagoda/NEAR focused wallet work
0 stars 0 forks source link

Boilerplate Template Frontend React

Report a Bug Ā· Request a Feature . Ask a Question

[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/shelegdmitriy/boilerplate-template-frontend/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [![code with love by shelegdmitriy](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-shelegdmitriy-ff1414.svg?style=flat-square)](https://github.com/shelegdmitriy)
Table of Contents - [About](#about) - [Built With](#built-with) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Deploy on Vercel](#deploy-on-vercel) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors & contributors](#authors--contributors) - [Security](#security)

About

This is a Next.js project bootstrapped with create-next-app and tailwindcss created for other boilerplate templates to easily set up and maintain a frontend part ony.

Built With

create-next-app, tailwindcss, tailwindui, @headlessui/react, @heroicons/react, amazing-github-template

Getting Started

Prerequisites

Make sure you have a current version of Node.js installed ā€“ we are targeting versions 18>.

Read about other prerequisites in our docs.

Installation

Install all dependencies:

npm install

Usage

Start your frontend:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Exploring The Code

  1. You can start editing the page by modifying frontend/pages/index.tsx. The page auto-updates as you edit the file.
  2. API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in frontend/pages/api/hello.ts.
  3. The frontend/pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
  4. This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Troubleshooting

On Windows, if you're seeing an error containing EPERM it may be related to spaces in your path. Please see this issue for more details.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer:

Project assistance

If you want to say thank you or/and support active development of Boilerplate Template Frontend React:

Together, we can make Boilerplate Template Frontend React better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Dmitriy Sheleg.

For a full list of all authors and contributors, see the contributors page.

Security

Boilerplate Template Frontend React follows good practices of security, but 100% security cannot be assured. Boilerplate Template Frontend React is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.