Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TSOND-544 | Updated the name of code repo to compass-starter-app #17

Merged
merged 1 commit into from
Sep 3, 2024
Merged

TSOND-544 | Updated the name of code repo to compass-starter-app #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,41 @@
# Universal Demo aka Compass Starter App
[![compass-starter-app](/public/contentstack-logo.png)](https://www.contentstack.com/)

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Compass Starter App

About Contentstack: Contentstack is a headless CMS with an API-first approach that puts content at the centre. It is designed to simplify the process of publication by separating code from content.

#####Recommended Node version: v18.17.0 and App Supported till v20.9.0
About this project: This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) used to build modern web applications.

![compass-starter-app](/public/starter-app.png)

##### Recommended Node version: v18.17.0 and App Supported till v22.6.0

## Getting Started

Refer .env.sample to set up env file
Refer [.env.sample](.env.sample) to set up your .env.local file in root directory

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
You can start editing the page by modifying `app/[locale]/page.tsx`. The page auto-updates as you edit the file.

## Compass Starter Stack Content Repo

[Compass Starter Stack Content Repo](https://github.com/contentstack/compass-starter-stack)

## Tutorial

We have created an in-depth tutorial on how you can create a starter website using the Contentstack's Node.js SDK and fetch its content using Contentstack.

[Build a Compass Starter Website with NextJS and Contentstack](https://www.contentstack.com/docs/developers/sample-apps/)

## Compass Starter Stack Content Stored for 1CT
[Compass Starter Stack Content Repo](https://github.com/Contentstack-Solutions/universal-demo-stack)
## Documentation

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
- [Contentstack documentation](https://www.contentstack.com/docs/)
- [Region support documentation](https://www.contentstack.com/docs/developers/selecting-region-in-contentstack-starter-apps)
- [Next.js](https://learnnextjs.com/)
Loading
Loading