Skip to content

Commit 6f6e2ee

Browse files
authored
Update README.md
1 parent 041d81e commit 6f6e2ee

File tree

1 file changed

+1
-117
lines changed

1 file changed

+1
-117
lines changed

README.md

Lines changed: 1 addition & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -199,121 +199,5 @@ Execute `npm run build:dev` command in the project's dir.
199199
## Other issues
200200
* If you will have any issue with the project starting, you can see errors in logs ("/logs" directory). Please, do this before the open an issue on GitHub. Don't forget to mention the version of the React Core Boilerplate (`JavaScript` or `TypeScript`)
201201

202-
# Project structure
203-
* **TypeScript** project:
204-
```shell
205-
| .gitignore
206-
| AppSettings.cs
207-
| appsettings.Development.json
208-
| appsettings.json
209-
| Constants.cs # Constants include fake authorization cookie keys.
210-
| package.json # NPM Package file.
211-
| Program.cs # Application entry point.
212-
| ReactSSR.WebApp.csproj # Visual Studio 2017 project file.
213-
| ReactSSR.WebApp.csproj.user
214-
| README.md
215-
| Startup.cs
216-
| tsconfig.json # TypeScript config file.
217-
| webpack.config.js # Server and client-side rendering WebPack configurations.
218-
| webpack.config.vendor.js # Server and client-side rendering WebPack Vendor configurations.
219-
|
220-
+---ClientApp
221-
| | boot-client.tsx # Frontend client-side entry point.
222-
| | boot-server.tsx # Frontend SSR entry point.
223-
| | configureStore.ts # Redux store definitions.
224-
| | global.d.ts # Global types definitions (e.g. ts-nameof, *.png, etc.)
225-
| | Globals.ts # Incapsulates global isomorphic data (e.g. authorization data).
226-
| | routes.tsx # Routes.
227-
| | Ui.ts # Incapsulates UI helpers initialization (e.g. tooltips).
228-
| | utils.ts # Helpful utils.
229-
| |
230-
| +---components # Components (not pages).
231-
| | +---person
232-
| | | PersonEditor.tsx # Example component.
233-
| | |
234-
| | \---shared # Shared components.
235-
| | AppComponent.tsx # Allows you to make the "force update" of the stucked components.
236-
| | AppRoute.tsx # Component for building routes with more than one layouts.
237-
| | ErrorBoundary.tsx # Component based on the error boundary pattern.
238-
| | Footer.tsx # Footer for authorized layout.
239-
| | Loader.tsx # Loader component.
240-
| | PagingBar.tsx # Paging component.
241-
| | TopMenu.tsx # Top menu component for authorized layout.
242-
| |
243-
| +---images
244-
| | logo.png # Boilerplate logo.
245-
| |
246-
| +---layouts # Layouts.
247-
| | AuthorizedLayout.tsx
248-
| | GuestLayout.tsx
249-
| |
250-
| +---models # Models which used in application.
251-
| | ILoginModel.ts
252-
| | IPersonModel.ts
253-
| | IServiceUser.ts
254-
| | ISessionData.ts
255-
| | Result.ts # Result pattern realization.
256-
| |
257-
| +---pages # Application pages.
258-
| | ExamplePage.tsx
259-
| | HomePage.tsx
260-
| | LoginPage.tsx
261-
| |
262-
| +---services # Isomorphic JS services which incapsulate the fetch logic.
263-
| | AccountService.ts # Fake authorization service.
264-
| | PersonService.ts # Example service.
265-
| | ServiceBase.ts # Isomorphic service base.
266-
| |
267-
| +---store # Redux stores.
268-
| | index.ts # Stores definition.
269-
| | LoginStore.ts
270-
| | PersonStore.ts # Example store definition.
271-
| |
272-
| \---styles
273-
| authorizedLayout.scss # Styles for authorized layout.
274-
| guestLayout.scss # Styles for guest layout.
275-
| loader.scss # Loader component styles.
276-
| main.scss # Common styles.
277-
| preloader.css # First run preloader styles.
278-
|
279-
+---Controllers
280-
| AccountController.cs # Fake accounts controller.
281-
| ControllerBase.cs # Incapsulates fake authorization properties.
282-
| MainController.cs # Entry point controller.
283-
| PersonController.cs # Example controller.
284-
|
285-
+---Extensions
286-
| ServiceCollectionExtensions.cs # Incapsulates methods which allow you to define lazy DI-containers.
287-
|
288-
+---Infrastructure # Folder for the infranstructure classes.
289-
| ExceptionMiddleware.cs # Middleware which allows you to catch exceptions during the runtime.
290-
| Result.cs # Result pattern realization on the server-side.
291-
| ServiceBase.cs # Facade as service pattern base class.
292-
|
293-
+---Models
294-
| LoginModel.cs # Model for fake authorization.
295-
| PersonModel.cs # Model for the example.
296-
| ServiceUser.cs
297-
| SessionData.cs # Isomorphic session data.
298-
|
299-
+---Services # Contains server-side services implementations.
300-
| AccountService.cs # Fake accounts service.
301-
| PersonService.cs # Example service implementation.
302-
|
303-
+---Views
304-
| | _ViewImports.cshtml
305-
| | _ViewStart.cshtml
306-
| |
307-
| +---Main
308-
| | Index.cshtml # Entry-point which incapsulates root app HTML container.
309-
| |
310-
| \---Shared
311-
| Error.cshtml
312-
|
313-
\---wwwroot # Root folder where will be located client-side bundles.
314-
favicon.ico
315-
316-
```
317-
318202
# License
319-
MIT
203+
MIT

0 commit comments

Comments
 (0)