Made with Xata

Made with Xata is a project gallery that showcases example projects built using the Xata platform. It includes a frontend gallery, with project details,user generated content, user authentication, and an admin interface for managing featured projects.

This project was built in public.

Getting Started

To get this project up and running, you'll need to:

1. Clone the repo
2. Run yarn install to download and install all the project dependencies.
3. Duplicate .env.example, naming the second file .env You'll need to adjust the values in that file with your own API Keys.
4. Run the development server:

npm run dev
# or
yarn dev

within the browser of your choice, go to http://localhost:3000.

Storybook

All the components within this project are documented within Storybook.

To get Storybook up and running:

yarn storybook

The Storybook script should automatically open a browser window. But, you can also go to http://localhost:6006/

Jest and JavaScript Testing Library

This project uses Jest and JavaScript Testing Library for testing. It makes use of the built-in Next.js Jest configuration and the Rust compiler. (It's fast!)

To get the test suite up and running:

yarn test

Plop

You can use PlopJS to stub out a folder within the src/components directory by running:

yarn plop component

The script will prompt you for the name of the component. Then, it will generate a folder with the component's name and four files inside:

1. Component file
2. Storybook File
3. Test file
4. Barrel file (index.ts file that makes importing components easier)

Xata

On the backend, all the data is being managed through Xata.