Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/therebelrobot/tngcp
A modern application template: The next generation of copypasta
https://github.com/therebelrobot/tngcp
Last synced: 9 days ago
JSON representation
A modern application template: The next generation of copypasta
- Host: GitHub
- URL: https://github.com/therebelrobot/tngcp
- Owner: therebelrobot
- License: mit
- Created: 2020-09-26T02:17:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-25T21:54:03.000Z (over 3 years ago)
- Last Synced: 2024-11-08T11:19:24.160Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 269 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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
- [x] Node @16
- [x] React @17.0.2
- [x] Next.js @11.0.1
- [x] Apollo/Graphql
- [x] apollo-server-micro @2.25.2
- [x] @apollo/client @3.3.20
- [x] Typescript @4.3.4
- [x] Chakra UI
- [x] Prettier @2.3.1
- [x] Build out README
- [ ] Explore Jest alternative (Cypress?)
- [ ] Build website
- [ ] Implement bootstrap CLI for NPM/npx
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
```sh
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
```sh
yarn start
# start reads the ENVIRONMENT env variable (from .env) to start production or development servers
```
and go to [localhost:9797](http://localhost:9797/) to see it started. A GraphQL playground is running on [localhost:9797/api/graphql](http://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 `.
3. Make your changes and commit them: `git commit -m ''`
4. Push to the original branch: `git push origin TNGCP/`
5. Create the pull request.
Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## Contributors
Thanks to the following people who have contributed to this project:
Aster Haven
💬
💻
📖
👀
We use the [All Contributors](https://github.com/all-contributors/all-contributors) specification and its [emoji key](https://allcontributors.org/docs/en/emoji-key). All contributions to this project are welcome!
## Contact
If you want to contact me you can reach me at .
## License
This project uses the following license: [MIT](https://tldrlegal.com/license/mit-license).