README.md (2350B)
1 # Elevate Rehab Site 2 #### version 3 3 4 ## Features 5 - [Tina Headless CMS](https://app.tina.io) for authentication, content modeling, visual editing and team management. 6 - Local development workflow from the filesystem with a local GraqhQL server. 7 8 ## Requirements 9 10 - Git, [Node.js Active LTS](https://nodejs.org/en/about/releases/), Yarn installed for local development. 11 - A [TinaCMS](https://app.tina.io) account for live editing. 12 13 ## Local Development 14 15 Install the project's dependencies: 16 17 ``` 18 yarn install 19 ``` 20 21 Run the project locally: 22 23 ``` 24 yarn dev 25 ``` 26 27 ### Local URLs 28 29 - http://localhost:3000 : browse the website 30 - http://localhost:3000/admin : connect to Tina Cloud and go in edit mode 31 - http://localhost:3000/exit-admin : log out of Tina Cloud 32 - http://localhost:4001/altair/ : GraphQL playground to test queries and browse the API documentation 33 34 ### Building the Starter Locally (Using the hosted content API) 35 36 Replace the `.env.example`, with `.env` 37 38 ``` 39 NEXT_PUBLIC_TINA_CLIENT_ID=<get this from the project you create at app.tina.io> 40 TINA_TOKEN=<get this from the project you create at app.tina.io> 41 NEXT_PUBLIC_TINA_BRANCH=<Specify the branch with Tina configured> 42 ``` 43 44 Build the project: 45 46 ```bash 47 yarn build 48 ``` 49 50 ## Getting Help 51 52 To get help with any TinaCMS challenges you may have: 53 54 - Visit the [documentation](https://tina.io/docs/) to learn about Tina. 55 - [Join our Discord](https://discord.gg/zumN63Ybpf) to share feedback. 56 - Visit the [community forum](https://community.tinacms.org/) to ask questions. 57 - Get support through the chat widget on the TinaCMS Dashboard 58 - [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. 59 - [Search or open an issue](https://github.com/tinacms/tinacms/issues) if something is not working. 60 - Reach out on Twitter at [@tina_cms](https://twitter.com/tina_cms). 61 62 ## Development tips 63 64 ### Visual Studio Code GraphQL extension 65 66 [Install the GraphQL extension](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql) to benefit from type auto-completion. 67 68 ### Typescript 69 70 A good way to ensure your components match the shape of your data is to leverage the auto-generated TypeScript types. 71 These are rebuilt when your `tina` config changes. 72 73 ## LICENSE 74 75 Licensed under the [Apache 2.0 license](./LICENSE).