-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md to be consistent with other demo repo's (#10)
* Update README.md to be consistent with other demo repo's * add images needed for readme
- Loading branch information
1 parent
198dac5
commit 2752f40
Showing
4 changed files
with
71 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,98 @@ | ||
<p align="center"> | ||
<a href="https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organization_demo" target="_blank" align="center"> | ||
<a href="https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organization_demo" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="./docs/clerk-logo-dark.png"> | ||
<img src="./docs/clerk-logo-light.png" height="64"> | ||
<source media="(prefers-color-scheme: dark)" srcset="./public/light-logo.png"> | ||
<img alt="Clerk Logo for light background" src="./public/dark-logo.png" height="64"> | ||
</picture> | ||
</a> | ||
<br /> | ||
</p> | ||
<div align="center"> | ||
<h1> | ||
Clerk Organizations Demo | ||
</h1> | ||
<a href="https://www.npmjs.com/package/@clerk/clerk-js"> | ||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@clerk/clerk-js" /> | ||
</a> | ||
<a href="https://clerk.com/docs?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter"> | ||
<img alt="Clerk Documentation" src="https://img.shields.io/badge/documentation-clerk-green.svg" /> | ||
</a> | ||
<a href="https://discord.com/invite/b5rXHjAg7A"> | ||
<img alt="Discord" src="https://img.shields.io/discord/856971667393609759?color=7389D8&label&logo=discord&logoColor=ffffff" /> | ||
</a> | ||
<a href="https://twitter.com/clerkdev"> | ||
<img alt="Twitter" src="https://img.shields.io/twitter/url.svg?label=%40clerkdev&style=social&url=https%3A%2F%2Ftwitter.com%2Fclerkdev" /> | ||
</a> | ||
<br /> | ||
<br /> | ||
<img alt="Clerk Hero Image" src="./public/hero.png"> | ||
</div> | ||
|
||
# Clerk Organizations Demo | ||
--- | ||
|
||
[![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord) | ||
[![Clerk documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) | ||
[![Follow on Twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev) | ||
## Introduction | ||
|
||
--- | ||
Clerk is a developer-first authentication and user management solution. It provides pre-built React components and hooks for sign-in, sign-up, user profile, and organization management. Clerk is designed to be easy to use and customize, and can be dropped into any React or Next.js application. | ||
|
||
This starter project shows how to use [Clerk](https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) with to build a rather lean interface showcasing the power of the [Organizations feature](https://clerk.com/docs/organizations/overview?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
Clerk organizations are a way of grouping your application's users. Organizations are shared accounts, useful for project and team leaders — think of GitHub Teams, or the different departments of a company. | ||
|
||
This starter project shows how to use [Clerk](https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) with Next.js to build a rather lean interface, showcasing the power of the [organizations feature](https://clerk.com/docs/organizations/overview?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
|
||
## Live Demo | ||
|
||
[https://organizations-demo.clerk.app](https://organizations-demo.clerk.app) | ||
|
||
## Getting Started | ||
## Running the demo | ||
|
||
### Prerequisites | ||
|
||
- React v18 | ||
|
||
- Node.js v18+ | ||
|
||
### Setup | ||
|
||
To run the example locally you need to: | ||
```bash | ||
gh repo clone clerk/organizations-demo | ||
``` | ||
|
||
To run the example locally, you need to: | ||
|
||
1. Sign up at [Clerk.com](https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
|
||
2. Go to your [Clerk dashboard](https://dashboard.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) and enable the Organizations feature. | ||
|
||
3. Set up your Publishable key and other variables, as shown in our [Getting started tutorial](https://clerk.com/docs/quickstarts/get-started-with-nextjs#install-clerk-s-sdk?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
|
||
4. `npm install` to install the required dependencies. | ||
|
||
5. `npm run dev` to launch the development server. | ||
|
||
## Learn more | ||
|
||
To learn more about Clerk and Next.js, and the organizations feature, check out the following resources: | ||
|
||
- [Clerk's organizations feature](https://clerk.com/docs/organizations/overview?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) | ||
|
||
- [Quickstart: Get started with Next.js and Clerk](https://clerk.com/docs/quickstarts/nextjs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-nextjs-pages-quickstart) | ||
|
||
- [Clerk Documentation](https://clerk.com/docs?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-nextjs-pages-quickstart) | ||
|
||
- [Next.js Documentation](https://nextjs.org/docs) | ||
|
||
## Found an issue? | ||
|
||
If you have found an issue with the quickstart, please create an [issue](https://github.com/clerkinc/clerk-nextjs-pages-quickstart/issues). | ||
|
||
If it's a quick fix, such as a misspelled word or a broken link, feel free to skip creating an issue. | ||
Go ahead and create a [pull request](https://github.com/clerkinc/clerk-nextjs-pages-quickstart/pulls) with the solution. :rocket: | ||
|
||
## Want to leave feedback? | ||
|
||
1. Sign up at [Clerk.com](https://www.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
2. Go to your [Clerk dashboard](https://dashboard.clerk.com/?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) and enable the Organizations feature. | ||
3. Setup your Publishable key and other variables as show at our [getting started documentation](https://clerk.com/docs/quickstarts/get-started-with-nextjs#install-clerk-s-sdk?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter). | ||
4. `npm install` to install the required dependencies. | ||
5. `npm run dev` to launch the development server. | ||
Feel free to create an [issue](https://github.com/clerkinc/clerk-nextjs-pages-quickstart/issues) with the **feedback** label. Our team will take a look at it and get back to you as soon as we can! | ||
|
||
## Support | ||
## Connect with us | ||
|
||
You can get in touch with us in any of the following ways: | ||
You can discuss ideas, ask questions, and meet others from the community in our [Discord](https://discord.com/invite/b5rXHjAg7A). | ||
|
||
- Join our official community [Discord server](https://clerk.com/discord) | ||
- Open a [GitHub support issue](https://github.com/clerk/javascript/issues/new?assignees=&labels=question&template=ask_a_question.md&title=Support%3A+) | ||
- Contact options listed on [our Support page](https://clerk.com/support?utm_source=github&utm_medium=starter_repos&utm_campaign=organizations_starter) | ||
If you prefer, you can also find support through our [Twitter](https://twitter.com/ClerkDev), or you can [email](mailto:[email protected]) us! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2752f40
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
organizations-demo – ./
organizations-demo.clerkstage.dev
organizations-demo-git-main.clerkstage.dev
organizations-demo.vercel.app
organizations-demo.clerk.app