https://github.com/kickstartds/staticcms-starter
https://github.com/kickstartds/staticcms-starter
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kickstartds/staticcms-starter
- Owner: kickstartDS
- License: other
- Created: 2024-02-11T13:54:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T09:22:06.000Z (over 2 years ago)
- Last Synced: 2025-07-18T18:46:59.813Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://staticcms-starter.vercel.app
- Size: 13.7 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kickstartDS Static CMS starter
This is a really simple project that shows the usage of Next.js with TypeScript.
## Deploy your own
[](https://app.netlify.com/start/deploy?repository=https://github.com/kickstartDS/staticcms-starter&stack=cms)
Once the initial build finishes, you will receive an "Invite" email to login to Static CMS.
## How to use it?
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
```bash
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
```
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
## Notes
This example shows how to integrate the TypeScript type system into Next.js. Since TypeScript is supported out of the box with Next.js, all we have to do is to install TypeScript.
```
npm install --save-dev typescript
```
To enable TypeScript's features, we install the type declarations for React and Node.
```
npm install --save-dev @types/react @types/react-dom @types/node
```
When we run `next dev` the next time, Next.js will start looking for any `.ts` or `.tsx` files in our project and builds it. It even automatically creates a `tsconfig.json` file for our project with the recommended settings.
Next.js has built-in TypeScript declarations, so we'll get autocompletion for Next.js' modules straight away.
A `type-check` script is also added to `package.json`, which runs TypeScript's `tsc` CLI in `noEmit` mode to run type-checking separately. You can then include this, for example, in your `test` scripts.
## Contributing
Contributions are welcome. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.
## License
This project is licensed under either of
- [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([LICENSE-APACHE](LICENSE-APACHE))
- [MIT license](https://opensource.org/license/mit/) ([LICENSE-MIT](LICENSE-MIT))
at your option.
The SPDX license identifier for this project is MIT OR Apache-2.0.
---
For more information and updates, please visit the project's GitHub repository.
## Support
Join our [Discord community](https://discord.gg/mwKzD5gejY) for support, or leave an issue on this repository!