Weavy + Refine
Get started
Installing our demo Refine app is the absolute fastest and best way to learn how Weavy and Refine work together.
Follow our guide below, and you'll be up and running in minutes.
Guide
Create a Refine app with Weavy components
This guide will show you what it looks like to integrate Weavy into a Refine app, quickly get a proof-of-concept up and running, and gain an understanding of what Weavy can do for your Refine apps.
Let's get started!
Prerequisites
We assume you are well acquainted with the Refine API and familiar with setting up a Refine based app.
This tutorial is based on the standard Refine NextJS example using NextAuth with Ant Design.
You will need:
1. Weavy API Key and backend
First we need an API key to communicate with the Weavy backend.
Sign up for an account
Before you can work with Weavy, you'll need to sign up for an account or sign into your existing account.
Select what environment you want to use for the tutorial
We need an API key to communicate with Weavy for authentication, etc
2. Clone the example repo
We have created an example where the Weavy components are added on top of the Refine example.
- Clone the repo.
- Open the example in the repo using your favorite editor.
Start by cloning the repo
git clone https://github.com/weavy-labs/weavy-refine-example.git weavy-refine-example3. Install dependencies
Change your directory to
weavy-refine-example and run:
Install
npm install4. Configure environment variables
To securely handle the Weavy configuration, we provide the environment url and the API key as environment variables.
Create an .env file in the root of your example project and place the Weavy configuration there.
.env
NEXT_PUBLIC_WEAVY_URL="WY_BACKEND_URL"
WEAVY_APIKEY="WY_API_*****************"Note
- Replace
WY_BACKEND_URLwith the url to your Weavy environment. - Replace
WY_API_*****************with the API key to your Weavy environment.
No API key selected
You haven't selected an API key. If you do - code snippets, scripts and files you download will automatically be updated with API key and backend URL.
5. Build
Now, let's compile the project.
Compile
npm run buildDeveloper mode
If you want to play with the code, you can run the developer mode instead using
npm run dev.6. Start
Start the project.
Run the project
npm startOnce up and running you can open the preview at
http://localhost:3000 to see the example in full action.7. Done!
We now have a complete Refine app running using Weavy components.
Make sure to explore:
- Seamlessly integrated authentication.
- Notifications available in the top bar.
- Messenger available in the top bar .
- Comments in the blog post view.
- Feeds, chat and files in the category view.
Now, imagine all this in your app!
Fill out all the values to continue.
Invalid input for the unique identifier.