This is a project template which could be used to the creation of new projects. Some of the features included are:
- Based on Next.js
- Tailwind as CSS Framework
- Reusable components such as forms, modals, icons, and other most use components
- Redux and Redux-Toolkit
- Typescript already configured
- Cypress as testing client
- git workflow and hooks
- editorconfig and code style based on Airbnb
- Storybook also available and configured
Check our documentation.
First, run the development server:
yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
To learn more about this project, take a look at the following resources:
- Blogin internal post - communication to Vizzuality
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- Standardization guidelines - a set of agreements and conventions.
First, we recommend to read the guideline about how to use Vercel.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out the Next.js deployment documentation for more details.
Please, create a PR for any improvement or feature you want to add. Try to not commit directly anything on the main branch.