Initial commit

2023-08-28 13:12:21 +02:00
commit 52134c91ef
78 changed files with 13869 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,82 @@
+# Tina Starter 🦙
+
+![tina-cloud-starter-demo](https://user-images.githubusercontent.com/103008/130587027-995ccc45-a852-4f90-b658-13e8e0517339.gif)
+
+This Next.js starter is powered by [TinaCMS](https://app.tina.io) for you and your team to visually live edit the structured content of your website. ✨
+
+The content is managed through Markdown and JSON files stored in your GitHub repository, and queried through Tina GraphQL API.
+
+### Features
+
+- [Tina Headless CMS](https://app.tina.io) for authentication, content modeling, visual editing and team management.
+- [Vercel](https://vercel.com) deployment to visually edit your site from the `/admin` route.
+- Local development workflow from the filesystem with a local GraqhQL server.
+
+## Requirements
+
+- Git, [Node.js Active LTS](https://nodejs.org/en/about/releases/), Yarn installed for local development.
+- A [TinaCMS](https://app.tina.io) account for live editing.
+
+## Local Development
+
+Install the project's dependencies:
+
+```
+yarn install
+```
+
+Run the project locally:
+
+```
+yarn dev
+```
+
+### Local URLs
+
+- http://localhost:3000 : browse the website
+- http://localhost:3000/admin : connect to Tina Cloud and go in edit mode
+- http://localhost:3000/exit-admin : log out of Tina Cloud
+- http://localhost:4001/altair/ : GraphQL playground to test queries and browse the API documentation
+
+### Building the Starter Locally (Using the hosted content API)
+
+Replace the `.env.example`, with `.env`
+
+```
+NEXT_PUBLIC_TINA_CLIENT_ID=<get this from the project you create at app.tina.io>
+TINA_TOKEN=<get this from the project you create at app.tina.io>
+NEXT_PUBLIC_TINA_BRANCH=<Specify the branch with Tina configured>
+```
+
+Build the project:
+
+```bash
+yarn build
+```
+
+## Getting Help
+
+To get help with any TinaCMS challenges you may have:
+
+- Visit the [documentation](https://tina.io/docs/) to learn about Tina.
+- [Join our Discord](https://discord.gg/zumN63Ybpf) to share feedback.
+- Visit the [community forum](https://community.tinacms.org/) to ask questions.
+- Get support through the chat widget on the TinaCMS Dashboard
+- [Email us](mailto:support@tina.io) to schedule a call with our team and share more about your context and what you're trying to achieve.
+- [Search or open an issue](https://github.com/tinacms/tinacms/issues) if something is not working.
+- Reach out on Twitter at [@tina_cms](https://twitter.com/tina_cms).
+
+## Development tips
+
+### Visual Studio Code GraphQL extension
+
+[Install the GraphQL extension](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql) to benefit from type auto-completion.
+
+### Typescript
+
+A good way to ensure your components match the shape of your data is to leverage the auto-generated TypeScript types.
+These are rebuilt when your `tina` config changes.
+
+## LICENSE
+
+Licensed under the [Apache 2.0 license](./LICENSE).