Get Started Building a Remix Website with Directus
By Eron Powell & Azri Kahar on February 21, 2022
This example will show you how to link a simple Remix frontend blog template to a Directus Project with a simple SQLite database containing a few blog posts.
Scope and Purpose
The purpose of this article is to focus on the bare basics of linking a Remix frontend to Directus, then show you where to learn about more robust authentication methods, roles & permissions configurations, and API functionalities. It is important to stress to new users that Directus is a general purpose database wrapper, which mirrors any linked database. No matter your data model or use-case, Directus can serve as a backend (plus no-code admin panel) for any type of project and also connect to any (or many) different front-ends.
Please keep in mind that this is not a demo showing what Directus can be used for, but rather a low variable entry-point on the path to understanding how to do anything you want with it.
This example was created for demonstration purposes and is not intended to be production ready, but PRs that address this and any other issues are always welcome! See Contribution Guidelines.
Setup
- Clone the examples repo.
Every frontend template in the examples repo references the shared folder. So moving these directories around from one location to another could break the relative file path.
From that repo, setup the provided Directus instance and get it running. Instructions are on the
README.mdpage.Install dependencies for this example.
cd remix
npm install
Create a
.envfile for this Remix template by copying and pasting the provided.env.examplefile. Nothing will need to be changed in the copied.envfile.Start the development server.
npm run dev
- Your Directus Remix example is now running at http://localhost:8080.
Now that you have the frontend and backend linked up, let's touch on what's happening in this project and where to find more sophisticated options.
Remix
Remix is a React framework for Server-side Rendering (SSR) composed of a compiler, server side HTTP handler, server framework and browser framework. Read the official Remix documentation to learn more.
Also, please note the Directus JavaScript SDK is pulled in under remix > app > lib > directus.js. If you're interested, see the directus.js file on GitHub and read more in the Directus SDK Documentation.
Authentication
Aside from the default local authentication mechanism, Directus also supports SSO through oauth2, openid, and ldap. To learn more about SSO options, read our SSO Documentation or follow our guide on how to setup SSO.
Users, Roles and Permissions
For simplicity's sake, this Directus instance provided has Public read permissions activated for articles and directus_users. Find Permissions in your local Directus Instance under Settings > Roles and Permissions.
Additionally, any number of Roles can be created and fully configured. Permissions are completely granular. Learn more about this in our documentation on Users, Roles and Permissions.
APIs
There are two simple requests in this example worth noting. The first is in index.jsx and the other in $id.jsx. If you'd like to see these, here are links to the index and $id components on GitHub. However, please note that the Directus API is exhaustive for any database linked.
Directus uses Database Mirroring to dynamically generate REST endpoints and a GraphQL schema based on the connected database's architecture. This means the REST and the GraphQL APIs will both fit any project with any database schema, out of the box. Learn more in the API Reference.
More Help
Looking for technical support for your non-enterprise project? Please visit the Directus Discord Community.
Want to stay focused on your content and apps? Let Directus manage the platform with our Directus Cloud service.