Skip to content

Commit e2835b1

Browse files
Frank Panettafattenap
authored andcommitted
remove crates, configs & entries dirs
1 parent efa88c7 commit e2835b1

37 files changed

+73
-69
lines changed

.github/workflows/main.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ jobs:
3737

3838
- name: Run tests
3939
run: cargo make verify_only
40-
working-directory: ./crate
4140

4241
- name: Install Netlify CLI
4342
if: github.ref == 'refs/heads/master'

.gitignore

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
dist
22
node_modules
3-
crate/bin
4-
crate/pkg
5-
crate/target
6-
crate/wasm-pack.log
3+
bin
4+
pkg
5+
target
6+
wasm-pack.log
77
.idea
88

9-
crate/src/generated/**
10-
!crate/src/generated/mod.rs
9+
src/generated/**
10+
!src/generated/mod.rs
1111
!**/.keep

.travis.yml_not_maintained

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ env:
3535
script:
3636
- yarn
3737
- yarn build:prerender # change it to `yarn build:release` if you don't want to prerender pages
38-
- cargo make --cwd ./crate verify_only # includes task `test_h_firefox`
38+
- cargo make verify_only # includes task `test_h_firefox`
3939

4040
before_deploy:
4141
- yarn global add netlify-cli

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
[UNRELEASED]
44

5+
[0.7.0]
6+
7+
- Moved files and directories located in `crate` directory to project root directory.
8+
- Moved files and directories located in `configs` directory to project root directory.
9+
- Moved files and directories located in `entries` directory to static directory.
10+
- Moved `entries/index.ts` to project root directoy.
11+
- Update/remove references to `crate`, `configs` and `entries` directories in configuration files and documentation.
12+
513
[0.6.0]
614

715
- Updated all JS dependencies.
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,17 @@ I want to show you how to create, build and host your website for free, so we wi
7575

7676
## 3. Prepare your project for work
7777

78-
1. Open terminal in your project and go to directory `crate` - `$ cd crate`
78+
1. Open terminal in your project
7979
1. Install Webpack and other dependencies - `$ yarn`
8080
1. Try to start dev-server - `$ yarn start` - and then open [localhost:8000](http://localhost:8000) in a browser.
8181
1. Stop server (try `Ctrl+c`).
8282
1. Try to lint your project - `$ cargo make verify_only` - you shouldn't see any errors.
83-
1. Modify files like `LICENCE`, `README.md` and `/crate/Cargo.toml` as you wish and push changes into GitHub.
83+
1. Modify files like `LICENCE`, `README.md` and `Cargo.toml` as you wish and push changes into GitHub.
8484

8585
## 4. Write your website
8686

8787
1. Open project in your favorite IDE. I use [IntelliJ](https://www.jetbrains.com/idea/download) or [VS Code](https://code.visualstudio.com/).
88-
1. Run `$ yarn start` in terminal. I use `bash` integrated into IDE (it's installed with Git on Windows).
89-
- _Note_: Yarn commands can be run from project root or from directory `crate`, but Cargo commands can be run **only from `crate`**.
88+
1. Run `$ yarn start` in terminal.
9089
1. Open [localhost:8000](http://localhost:8000) in a browser.
9190
1. You can open it also in your mobile phone:
9291
1. Make sure your dev-server aka computer is in the same network as your phone.
@@ -97,73 +96,73 @@ _Note_: You don't have to follow all steps below - reuse starter project code as
9796

9897
### Header
9998

100-
1. Open `/crate/src/page/partial/header.rs` in your IDE.
99+
1. Open `src/page/partial/header.rs` in your IDE.
101100
1. Delete function `header_visibility`.
102101
1. Write a new body for function `view`.
103102

104103
### Footer
105104

106-
1. Open `/crate/src/page/partial/footer.rs` in your IDE.
105+
1. Open `src/page/partial/footer.rs` in your IDE.
107106
1. Write a new body for function `view`.
108107

109108
### 404
110109

111-
1. Open `/crate/src/page/not_found.rs` in your IDE.
110+
1. Open `src/page/not_found.rs` in your IDE.
112111
1. Write a new body for function `view`.
113112

114113
### Home page
115114

116-
1. Open `/crate/src/page/home.rs` in your IDE.
115+
1. Open `src/page/home.rs` in your IDE.
117116
1. Write a new body for function `view`.
118117

119118
### About page
120119

121-
1. Open `/crate/src/page/about.rs` in your IDE.
120+
1. Open `src/page/about.rs` in your IDE.
122121
1. Write a new body for function `view`.
123122

124123
### App core
125124

126-
1. Open `/crate/src/lib.rs` in your IDE.
125+
1. Open `src/lib.rs` in your IDE.
127126
1. Change `TITLE_SUFFIX` value.
128127
1. Delete `MAIL_TO_KAVIK` and `MAIL_TO_HELLWEB`.
129128
1. Write a new body for function `view`.
130129

131130
### Favicons
132131

133132
1. Delete or replace files in `/favicons`.
134-
1. Open `/entries/templates/favicons.hbs` in your IDE.
133+
1. Open `static/templates/favicons.hbs` in your IDE.
135134
1. Delete content or update it.
136135
- _Note_: Templates are written in [Handlebars](https://handlebarsjs.com/).
137136

138137
### Loading page
139138

140-
1. Open `/entries/templates/loading_page.hbs` in your IDE.
139+
1. Open `static/templates/loading_page.hbs` in your IDE.
141140
1. Delete content or update it.
142141

143142
### Social media & basic settings
144143

145-
1. Open `/entries/templates/social_media.hbs` in your IDE.
144+
1. Open `static/templates/social_media.hbs` in your IDE.
146145
1. Delete content or update it.
147146

148147
### Basic HTML
149148

150-
1. Open `/entries/index.hbs` in your IDE.
149+
1. Open `static/index.hbs` in your IDE.
151150
1. Update content.
152151

153152
### Fonts
154153

155-
1. Delete or replace files and directories in `/static/fonts`.
154+
1. Delete or replace files and directories in `static/fonts`.
156155
1. Open `/css/fonts.css` in your IDE.
157156
1. Delete content or update it.
158157

159158
### Images & other files
160159

161-
1. Delete or replace files in `/static/images`.
162-
1. Delete `/static/Martin_Kavik_resume.pdf`.
160+
1. Delete or replace files in `static/images`.
161+
1. Delete `static/Martin_Kavik_resume.pdf`.
163162

164163
### TailwindCSS
165164

166-
1. Open `/configs/tailwind.config.js` in your IDE.
165+
1. Open `tailwind.config.js` in your IDE.
167166
1. Update content or replace it with the default one:
168167

169168
```js
@@ -189,25 +188,25 @@ And how to setup Github Actions with deploy into Netlify.
189188

190189
1. Format: `$ cargo make fmt` (it overwrites files) or only `$ cargo make fmt_check`
191190
1. You can modify format settings in:
192-
- `/crate/rustfmt.toml`
193-
- `/crate/Makefile.toml` - tasks `fmt` and `fmt_check`
191+
- `rustfmt.toml`
192+
- `Makefile.toml` - tasks `fmt` and `fmt_check`
194193
1. Lint: `$ cargo make clippy`
195194
1. You can modify linter settings in:
196-
- `/crate/Makefile.toml` - task `clippy`
195+
- `Makefile.toml` - task `clippy`
197196

198197
### Testing
199198

200199
1. Run `$ cargo make test_h firefox` for headless testing in Firefox.
201-
- There are more similar commands - see `/crate/Makefile.toml`
202-
- _Note_: There is only one test in this project (`crate/tests/test.rs`), see [seed-rs-realworld](https://github.com/seed-rs/seed-rs-realworld) for more examples.
200+
- There are more similar commands - see `Makefile.toml`
201+
- _Note_: There is only one test in this project (`tests/test.rs`), see [seed-rs-realworld](https://github.com/seed-rs/seed-rs-realworld) for more examples.
203202
1. If you want to test prerendered website:
204203
1. `$ yarn build:prerender`
205204
1. `$ yarn serve:dist`
206205
1. Open [localhost:8000](http://localhost:8000) in a browser.
207206
1. _Tip_: Always test it also in production environment because e.g. routing is a little bit different among servers.
208207
1. **Always run `$ cargo make verify`** before push to make sure CI pipeline will accept your code.
209208
- It'll format your code, lint it and start headless tests in Firefox.
210-
- You can change its behaviour in `/crate/Makefile.tom` - task `verify` (similar task `verify_only` is used in CI).
209+
- You can change its behaviour in `Makefile.tom` - task `verify` (similar task `verify_only` is used in CI).
211210

212211
### Netlify
213212

RELEASE_CHECKLIST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
1. Update `CHANGELOG.md` (content + increment version).
44
1. Update version also in `package.json`.
5-
1. In `/crate`: `cargo make verify`
5+
1. Run `cargo make verify`
66
1. Commit "v#.#.#".
77
1. Push.
88
1. Wait for the CI to go green.
9-
1. Create GitHub release (create a new tag).
9+
1. Create GitHub release (create a new tag).

configs/tsconfig.css_classes.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)