@@ -52,7 +52,7 @@ The greatest care is devoted to a solid, clear, comprehensive, understandable, m
52
52
53
53
- Organized assets structure for both optimized (` /src ` ) and un-optimized (` /public ` ) images with extracted defaults
54
54
- ` astro-icon ` package supporting both material design (` mdi ` ) icons and local SVG's
55
- - Paginated list pages for filtering posts: by tag - ` /tags ` , by category - ` categories ` , by both - ` /explore ` - Explore (Archive) page
55
+ - Paginated list pages for filtering posts: by tag - ` /tags ` , by category - ` / categories` , by both - ` /explore ` - Explore (Archive) page
56
56
- Collapsible navbar with items stored as array and active item for the current route
57
57
- Table of contents for blog posts
58
58
- Design system with ` .mdx ` pages available at ` /design ` path for clear preview and debugging of all visual components
@@ -85,6 +85,45 @@ The greatest care is devoted to a solid, clear, comprehensive, understandable, m
85
85
- The same bash scripts reused for both Github Actions and local deployments for easy debugging locally
86
86
- Support for building both ` x86 ` and ` arm ` Docker images
87
87
88
+ ## Installation and running
89
+
90
+ ### Development
91
+
92
+ ``` bash
93
+ # install packages
94
+ yarn install
95
+
96
+ # copy and set environment variables
97
+ cp .env.development.example .env.development
98
+
99
+ # run development server and visit http://localhost:3000
100
+ yarn dev
101
+
102
+ # delete node_modules and yarn.lock
103
+ yarn clean
104
+ ```
105
+
106
+ ### Production
107
+
108
+ ``` bash
109
+ # copy and set environment variables
110
+ cp .env.production.example .env.production
111
+
112
+ # build website
113
+ yarn build
114
+
115
+ # run website
116
+ yarn start
117
+ ```
118
+
119
+ ## Deployment
120
+
121
+ ``` bash
122
+
123
+ # deploy local /dist folder to the remote Nginx server
124
+ yarn deploy:nginx
125
+ ```
126
+
88
127
## Roadmap
89
128
90
129
- Add accessibility attributes
0 commit comments