Skip to content

Commit 1e4d7f1

Browse files
authored
chore: update README (#9)
1 parent d53ab3c commit 1e4d7f1

4 files changed

+850
-528
lines changed

.dependency-cruiser.cjs

+1
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,7 @@ module.exports = {
342342
'node_modules/(@[^/]+/[^/]+|[^/]+)',
343343
'src/(app/[^/]+/)',
344344
'src/(pages/[^/]+/)',
345+
'src/(features/[^/]+/[^/]+/)',
345346
'src/([^/]+/[^/]+)',
346347
// 'src/(app/[^/]+/)',
347348
// 'src/(pages/[^/]+/)',

README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
1-
### React + Zustand + React-Query codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API. Powered by [FSD (Feature-Sliced Design)](https://feature-sliced.design/) architectural methodology.
1+
<div>
2+
<h1 align="center">🙌 RealWorld example app 🍰 Feature-Sliced Design</h1>
23

3-
<br/>
4+
<p>
5+
This codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the <a href="https://github.com/gothinkster/realworld">RealWorld</a> spec and API. Powered by <a href="https://feature-sliced.design">FSD (Feature-Sliced Design)</a> architectural methodology.
6+
</p>
7+
8+
<a href="https://realworld-fsd.netlify.app">
9+
<img
10+
alt="Realworld example app website"
11+
src="./logo.gif"
12+
/>
13+
</a>
14+
</div>
15+
16+
<hr />
417

518
[![Netlify Status][netlify-domain]](https://realworld-fsd.netlify.app/)
619
[![Build workflow][build-domain]](https://github.com/sldk-yuri/realworld-react-fsd/actions/workflows/build.yml)
720
[![Codecov][codecov-domain]](https://app.codecov.io/gh/sldk-yuri/realworld-react-fsd/branch/master)
821
[![Code style: prettier][prettier-domain]](https://github.com/prettier/prettier)
922
[![license][license-domain]](https://github.com/sldk-yuri/realworld-react-fsd/blob/master/LICENSE)
1023

11-
![Dependency Graph][dependency-graph-domain]
12-
13-
This codebase was created to demonstrate a fully fledged fullstack application built with **React + Zustand + React-Query and Feature-Sliced Design architectural methodology** including CRUD operations, authentication, routing, pagination, and more.
14-
15-
We've gone to great lengths to adhere to the **React + Zustand + React-Query and Feature-Sliced Design architectural methodology** community styleguides & best practices.
16-
17-
For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) and [FSD](https://github.com/feature-sliced/documentation) repos.
18-
1924
# Features
2025

2126
The example application is a social blogging site (i.e. a Medium.com clone) called "Conduit". It uses a custom API for all requests, including authentication.
2227

28+
![Dependency Graph][dependency-graph-domain]
29+
2330
**General functionality:**
2431

2532
- Authenticate users via JWT (login/signup pages + logout button on settings page)

0 commit comments

Comments
 (0)