Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahaywood/made-with-xata
This is a gallery that showcases projects Made with Xata.
https://github.com/ahaywood/made-with-xata
javascript-testing-library jest nextjs react tailwind xata
Last synced: about 22 hours ago
JSON representation
This is a gallery that showcases projects Made with Xata.
- Host: GitHub
- URL: https://github.com/ahaywood/made-with-xata
- Owner: ahaywood
- Created: 2023-02-18T00:25:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-22T16:14:30.000Z (over 1 year ago)
- Last Synced: 2024-03-17T11:35:59.211Z (8 months ago)
- Topics: javascript-testing-library, jest, nextjs, react, tailwind, xata
- Language: TypeScript
- Homepage: http://madewithxata.com
- Size: 2.09 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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.](https://www.notion.so/ahhacreative/Project-Page-Made-with-Xata-e1c3579bb49e4713bdd7a77b2e6f415a?pvs=4)
## 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:
```bash
npm run dev
# or
yarn dev
```
within the browser of your choice, go to [http://localhost:3000](http://localhost:3000).
## Storybook
All the components within this project are documented within [Storybook](https://storybook.js.org/).
To get Storybook up and running:
```bash
yarn storybook
```
The Storybook script should automatically open a browser window. But, you can also go to [http://localhost:6006/](http://localhost:6006/)
## Jest and JavaScript Testing Library
This project uses [Jest](https://jestjs.io/) and [JavaScript Testing Library](https://testing-library.com/) for testing. It makes use of the [built-in Next.js Jest configuration and the Rust compiler](https://nextjs.org/docs/testing#jest-and-react-testing-library). (It's fast!)
To get the test suite up and running:
```bash
yarn test
```
## Plop
You can use PlopJS to stub out a folder within the `src/components` directory by running:
```bash
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
1. Storybook File
1. Test file
1. Barrel file (index.ts file that makes importing components easier)
## Xata
On the backend, all the data is being managed through [Xata](https://xata.io/).