Skip to content
/ tngcp Public template

A modern application template: The next generation of copypasta

License

Notifications You must be signed in to change notification settings

therebelrobot/tngcp

Repository files navigation

TNGCP_banner

Typescript + Next.js + GraphQL + Chakra UI + Prettier boilerplate.

Note: I'm updating this to more modern versions in the next few days/weeks, so stay tuned

Todo's

  • Update core libraries to latest
    • Node @16
    • React @17.0.2
    • Next.js @11.0.1
    • Apollo/Graphql
      • apollo-server-micro @2.25.2
      • @apollo/client @3.3.20
    • Typescript @4.3.4
    • Chakra UI
    • Prettier @2.3.1
  • Build out README
  • Explore Jest alternative (Cypress?)
  • Build website
  • Implement bootstrap CLI for NPM/npx

GitHub repo size GitHub contributors GitHub stars GitHub forks GitHub issues GitHub license Twitter Follow

TNGCP is a production-ready application template that allows fullstack engineers to quickly bootstrap a new application with sane and secure defaults.

I mainly made this because I kept remaking it over and over, and wanted an easy way to copypasta that for future projects.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of Node (v16, ideally using NVM)
  • You have a Mac or Linux machine. Windows might work, but I haven't tested it there.

Starting out with TNGCP

Copy the codebase

The fast way(s)

  • Github Templates: Click the green "Use This Template" button on the main page of the repo, set the name of your new repo, and there you go
  • [to come] tngcp cli: run the TNGCP cli tool. This is a work in progress, and more docs will be available in the future.

The slow way(s)

  • Git clone this repo, change the remote url to your git repo, push the changes
  • Download a zip file of this repo, place wherever you manage your websites

Install dependencies

nvm install && nvm use # this will read .nvmrc to install/switch to Node 16
yarn install # node module dependencies
cp .env.example .env # ensure environment variables are set properly for development

Run application

yarn start
# start reads the ENVIRONMENT env variable (from .env) to start production or development servers

and go to localhost:9797 to see it started. A GraphQL playground is running on localhost:9797/api/graphql

Contributing to TNGCP

To contribute to TNGCP, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin TNGCP/<location>
  5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the following people who have contributed to this project:


Aster Haven

💬 💻 📖 👀

We use the All Contributors specification and its emoji key. All contributions to this project are welcome!

Contact

If you want to contact me you can reach me at github@aster.hn.

License

This project uses the following license: MIT.

About

A modern application template: The next generation of copypasta

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published