Skip to content

Commit 2d313d1

Browse files
authored
Update README.md
1 parent 4691f5f commit 2d313d1

File tree

1 file changed

+47
-18
lines changed

1 file changed

+47
-18
lines changed

README.md

Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,55 @@
1-
# Portfolio for developers
1+
# Code for Dallas Website
2+
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+
5+
# To do
6+
7+
Aside from minor optimizations, here are the main checklist items before we move to production:
8+
- Edit environment variables (GitHub token, Formcarry endpoint and Recaptcha key).
9+
- Update projects section, which currently just fetches Anthony's top repositories from GitHub (we could replace it with a slideshow or something).
10+
- Update team member descriptions and photos.
11+
12+
# Contributing
13+
14+
We welcome contributions to this project. First of all, here's the project structure:
15+
16+
## Structure
17+
18+
```bash
19+
.
20+
├── data
21+
│ └── config # SEO related tags
22+
├── src
23+
│ └── assets # Assets
24+
│ │ │── icons # icons
25+
│ │ │── illustrations # illustrations from (undraw.co)
26+
│ │ └── thumbnail # cover of your website when it's shared to social media
27+
│ ├── components # Components
28+
│ │ │── common # Common components
29+
│ │ │── landing # Components used on the landing page
30+
│ │ └── theme # Header & Footer
31+
│ └── pages # Pages
32+
└── static # favicon & Netlify redirects
33+
```
34+
35+
## Get started
36+
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+
1. Create an account at [Formik](https://formik.com/?utm_source=smakosh)
39+
2. Install [Yarn](https://yarnpkg.com/en/)
40+
3. Grab a Google recaptcha key from [Google Recaptcha](https://www.google.com/recaptcha/admin)
41+
4. Run `cp .env.development.template .env.development`
42+
5. Run `yarn && yarn start`
43+
244

345
[![Deploy with Vercel](https://vercel.co/button)](https://vercel.co/new/project?template=https://github.com/smakosh/gatsby-portfolio-dev)
446

547
[![Powered by Vercel](./powered-by-vercel.svg)](https://vercel.co?utm_source=smakosh)
648

49+
# How the project was made
50+
51+
This project was made with a theme called "Gatsby theme portfolio." What follows is the original readme from this theme.
52+
753
## Theme
854

955
[Gatsby-theme-portfolio](https://github.com/smakosh/gatsby-theme-portfolio)
@@ -28,24 +74,7 @@
2874

2975
Project on [Behance](https://www.behance.net/gallery/74172961/Free-Gatsby-portfolio-for-developers)
3076

31-
## Structure
3277

33-
```bash
34-
.
35-
├── data
36-
│ └── config # SEO related tags
37-
├── src
38-
│ └── assets # Assets
39-
│ │ │── icons # icons
40-
│ │ │── illustrations # illustrations from (undraw.co)
41-
│ │ └── thumbnail # cover of your website when it's shared to social media
42-
│ ├── components # Components
43-
│ │ │── common # Common components
44-
│ │ │── landing # Components used on the landing page
45-
│ │ └── theme # Header & Footer
46-
│ └── pages # Pages
47-
└── static # favicon & Netlify redirects
48-
```
4978

5079
## Prerequisites
5180

0 commit comments

Comments
 (0)