Installation

Requirements

• Node.js v18 or above, with support for even-numbered Node.js versions.
• The supported TypeScript version is set upon installation. Upgrading to a newer version of TypeScript might result in compilation errors.
• If you want to use MySQL, MariaDB, or Postgres as your data store, then you'll need an instance available locally. However, if you are just testing out Deenruv, we recommend using SQLite, which has no external requirements.
• If you use Yarn, you'll need to use Yarn 2 (Berry) or above.

@deenruv/create

The recommended way to get started with Deenruv is by using the @deenruv/create tool. This is a command-line tool which will scaffold and configure your new Deenruv project and install all dependencies.

1. Run the command

npx @deenruv/create my-shop

2. Select a database

Deenruv supports a number of different databases. The @deenruv/create tool will prompt you to select one.

To quickly test out Deenruv, we recommend using SQLite, which requires no external dependencies. You can always switch to a different database later by changing your configuration file.

3. Populate with data

The final prompt will ask whether to populate your new Deenruv server with some sample product data.

We recommend you do so, as it will give you a good starting point for exploring the APIs which we will cover in the Try the API section, as well as providing some data to use when building your own storefront.

4. Complete setup

Next, a project scaffold will be created and dependencies installed. This may take a few minutes.

Once complete, you'll see a message like this:

5. Start the server

Follow the instructions to move into the new directory created for your project, and start the server:

cd my-shop

yarn dev
# or
npm run dev

You should now be able to access:

• The Deenruv Admin GraphQL API: http://localhost:6100/admin-api
• The Deenruv Shop GraphQL API: http://localhost:6100/shop-api
• The Deenruv Admin UI: http://localhost:6100/admin

Congratulations! 🥳 You now have a fully-functional Deenruv server running locally.

Now you can explore Deenruv by following our Try the API guide to learn how to interact with the server.

If you are new to GraphQL, you should also check out our Introducing GraphQL guide.

Troubleshooting

If you encounter any issues during installation, you can get a more detailed output by setting the log level to verbose:

npx @deenruv/create my-shop --log-level verbose

Set up a storefront

Once you have a Deenruv server running, you can set up a storefront to interact with it!

We have a number of storefront starter kits available for you to use - head over to the Storefront Starters page to learn more.