Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/richardnguyen99/richardnguyen99-v1
Personal website
https://github.com/richardnguyen99/richardnguyen99-v1
gatsby graphql reactjs styled-components typescript
Last synced: about 14 hours ago
JSON representation
Personal website
- Host: GitHub
- URL: https://github.com/richardnguyen99/richardnguyen99-v1
- Owner: richardnguyen99
- License: mit
- Created: 2019-12-13T22:38:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T21:04:20.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T20:18:51.930Z (over 1 year ago)
- Topics: gatsby, graphql, reactjs, styled-components, typescript
- Language: TypeScript
- Homepage: https://richardnguyen99.netlify.com
- Size: 8.12 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# richardnguyen.github.io
[](https://app.netlify.com/sites/richardnguyen99/deploys)
A personal website of Richard Nguyen and this is its source code. This website is written in [Gatsby](https://www.gatsbyjs.org/), [React](https://reactjs.org/), [Typescript](https://www.typescriptlang.org/) and [Styled-components](https://www.styled-components.com/).
_Notes: Richard open-sources his website to share the structure, the configurations, and how he organizes all of those things. He hopes that it could help some people are having troubles in writing their very first sites (in Gatsby and stuff). However, the website is highly customized to match his desires, so it could be a little frustrating to modify the codes to your version. But he will be happy if you do so. Not only will you improve your coding skills but also respect him and what he's doing._
## Usage
1. Clone the repository
```shell
git clone https://github.com/richardnguyen99/richardnguyen99.github.io
```
2. Know the structure
Before getting your hands on, Richard would like to tell you more about how he organizes stuff. Richard only explains his stuff. Others can be seen at [gatsby-starter-default](https://github.com/gatsbyjs/gatsby-starter-default)
- In the root directory:
- **_.editorconfig_**: a set of consistent formatting styles for the whole project.
- **_.eslintrc.js_**: a tool to check all Javascript errors and fix them.
- **_.eslintignore_**: a list of files and folders that ESLint will ignore.
- **_.huskyrc_**: a pre-commit hook script to prevent bad commits.
- **_.lintstagedrc_**: a linter linting files on staged.
- **_.stylelintrc_**: a tool like ESLint but for CSS.
- **_tsconfig.json_**: a set of rules and configurations for Typescript compiler.
- In the source directory:
- **_@types/_**: customized type definitions.
- **_components/_**: reusable components.
- **\_contexts/\_\_**: React context (theme, languagues, etc.).
- **_hooks/_**: customized React hooks.
- \***\*images/\*\***: images for displaying content of the website.
- \***\*pages/\*\***: contents will be displayed on the website
- \***\*utils/\*\***: sets of tools to help in development process.
- \***\*types.ts\*\***: list of types and interfaces.
3. Play around:
Development:
```shell
yarn develop
```
Production:
```shell
yarn build
```
4. Deploy:
Currently, this website is being deployed to [Netlify](https://www.netlify.com/) (free for static website), so the script `yarn deploy` won't work properly (You can try if you still want to).
## Authors
- [Richard Nguyen](https://github.com/richardnguyen99)
## Contribution & Contact
If you found any problems or issues, please feel free to open a pull request to fix that. Richard would be happy if there were someone improving the website with him. If a pull request is unnecessary, you contact him with:
- Github:
- Reddit:
- Twitter: