Skip to content

A simple Next.js application with TypeScript, Tailwind CSS and testing suite enabled

License

Notifications You must be signed in to change notification settings

KennyStanleyJr/nextjs-project

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Next.js Project Template

A simple Next.js application with TypeScript, Tailwind CSS and testing suite enabled
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Next.js Project Screenshot

A starting boilerplate for a TS Next.js project with batteries included. Tailwind CSS in JIT mode for styling, Jest and React Testing Library working with path aliases and node-mock-http for API route testing.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Install yarn (or replace yarn commands with the npm equivalent)

  • yarn
    npm install --global yarn

Installation

  1. Clone the repo
    git clone https://github.com/KennyStanley/nextjs-project.git
  2. Install dependencies
    yarn

(back to top)

Usage

  • To run dev environment:
    yarn dev 
  • To run prod environment:
    yarn build
    yarn start
  • To run tests:
    yarn test

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Kenny Stanley - @KennyStanleyJr - kennystanley615@gmail.com

Project Link: https://github.com/KennyStanley/nextjs-project

(back to top)

Acknowledgments

(back to top)

About

A simple Next.js application with TypeScript, Tailwind CSS and testing suite enabled

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published