2
2
3
3
A clean and modern homepage for a clean and modern organization. This site was built using Gatsby, a static site generator. Currently under development.
4
4
5
- # To do
5
+ ## To do
6
6
7
7
Aside from minor optimizations, here are the main checklist items before we move to production:
8
8
- Edit environment variables (GitHub token, Formcarry endpoint and Recaptcha key).
9
9
- Update projects section, which currently just fetches Anthony's top repositories from GitHub (we could replace it with a slideshow or something).
10
10
- Update team member descriptions and photos.
11
11
12
- # Contributing
12
+ ## Contributing
13
13
14
14
We welcome contributions to this project. First of all, here's the project structure:
15
15
16
- ## Structure
16
+ ### Structure
17
17
18
18
``` bash
19
19
.
@@ -32,7 +32,7 @@ We welcome contributions to this project. First of all, here's the project struc
32
32
└── static # favicon & Netlify redirects
33
33
```
34
34
35
- ## Get started
35
+ ### Get started
36
36
37
37
If you're familiar with Gatsby, go ahead and fork the repo and start making changes. Otherwise, here are the steps for local installation:
38
38
1 . Create an account at [ Formik] ( https://formik.com/?utm_source=smakosh )
@@ -46,15 +46,15 @@ If you're familiar with Gatsby, go ahead and fork the repo and start making chan
46
46
47
47
[ ![ Powered by Vercel] ( ./powered-by-vercel.svg )] ( https://vercel.co?utm_source=smakosh )
48
48
49
- # How the project was made
49
+ ## How the project was made
50
50
51
51
This project was made with a theme called "Gatsby theme portfolio." What follows is the original readme from this theme.
52
52
53
- ## Theme
53
+ ### Theme
54
54
55
55
[ Gatsby-theme-portfolio] ( https://github.com/smakosh/gatsby-theme-portfolio )
56
56
57
- ## Features
57
+ ### Features
58
58
59
59
- Eslint/Prettier configured
60
60
- Scores 100% on a11y / Performance / PWA / SEO
@@ -70,15 +70,15 @@ This project was made with a theme called "Gatsby theme portfolio." What follows
70
70
- Functional components with ~~ Recompose~~ React Hooks! ~~ ready to migrate to React hooks!~~
71
71
- Fetches your Github pinned projects with most stars (You could customize this if you wish)
72
72
73
- ## Design
73
+ ### Design
74
74
75
75
Project on [ Behance] ( https://www.behance.net/gallery/74172961/Free-Gatsby-portfolio-for-developers )
76
76
77
77
78
78
79
- ## Prerequisites
79
+ ### Prerequisites
80
80
81
- ### Online
81
+ #### Online
82
82
83
83
1 . Create an account at [ Formik] ( https://formik.com/?utm_source=smakosh ) and grab your form endpoint url
84
84
2 . Grab a Google recaptcha key from [ Google Recaptcha] ( https://www.google.com/recaptcha/admin )
@@ -91,15 +91,15 @@ Project on [Behance](https://www.behance.net/gallery/74172961/Free-Gatsby-portfo
91
91
92
92
To Vercel's now secrets UI form.
93
93
94
- ### Locally
94
+ #### Locally
95
95
96
96
1 . Create an account at [ Formik] ( https://formik.com/?utm_source=smakosh )
97
97
2 . Install [ Yarn] ( https://yarnpkg.com/en/ )
98
98
3 . Grab a Google recaptcha key from [ Google Recaptcha] ( https://www.google.com/recaptcha/admin )
99
99
4 . Run ` cp .env.development.template .env.development `
100
100
5 . Run ` yarn && yarn start `
101
101
102
- ### Deploying locally to Vercel
102
+ #### Deploying locally to Vercel
103
103
104
104
I highly recommend that you push to GitHub/GitLab and deploy your repository to Vercel instead or just hit the Deploy button.
105
105
@@ -108,15 +108,15 @@ Otherwise, you will have to do the following:
108
108
1 . Add your secrets one by one using the [ Now CLI] ( https://vercel.co/docs/now-cli )
109
109
2 . Run ` now `
110
110
111
- ### Clean the cache
111
+ #### Clean the cache
112
112
113
113
This removes the ` .cache/ ` & ` public/ ` folders
114
114
115
115
``` bash
116
116
yarn reset
117
117
```
118
118
119
- ## Built with
119
+ ### Built with
120
120
121
121
- Adobe XD
122
122
- Gatsby
@@ -126,11 +126,11 @@ yarn reset
126
126
- VSCode
127
127
- And these useful of JavaScript libraries & Gatsby plugins [ package.json] ( package.json )
128
128
129
- ## License
129
+ ### License
130
130
131
131
This project is licensed under the MIT License - see the [ LICENSE.md] ( LICENSE.md ) file for details
132
132
133
- ## Contributors
133
+ ### Contributors
134
134
135
135
- [ Ajay NS] ( https://github.com/ajayns ) https://github.com/smakosh/gatsby-portfolio-dev/pull/3
136
136
- [ Ryan Lee] ( https://github.com/drdgvhbh ) https://github.com/smakosh/gatsby-portfolio-dev/pull/6
@@ -141,6 +141,6 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md
141
141
- [ Michael Seifarth] ( https://github.com/Kageetai ) https://github.com/smakosh/gatsby-portfolio-dev/pull/27
142
142
- [ Smakosh] ( https://smakosh.com )
143
143
144
- ## Support
144
+ ### Support
145
145
146
146
If you love this Gatsby template and want to support me, you can do so through my GitHub profile.
0 commit comments