Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kien-dang/react-resume-template
A lightweight React-TypeScript resume web template.
https://github.com/kien-dang/react-resume-template
react resume-template typescript
Last synced: 3 months ago
JSON representation
A lightweight React-TypeScript resume web template.
- Host: GitHub
- URL: https://github.com/kien-dang/react-resume-template
- Owner: kien-dang
- License: mit
- Created: 2020-08-19T11:25:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-21T10:46:17.000Z (over 2 years ago)
- Last Synced: 2024-08-02T06:13:21.957Z (6 months ago)
- Topics: react, resume-template, typescript
- Language: TypeScript
- Homepage:
- Size: 9.31 MB
- Stars: 13
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- templates - React Resume Template by kien-dang
README
# React TypeScript Resume Web Template
A lightweight React-TypeScript resume web template for all people.
[LIVE DEMO](https://kiendang.com)
## Do you want to use it on your own?
This project is completely free of charge. It can be customised and used by anybody simply by modifying JSON config and components to tailor with their needs.
If you would like to use this template for your own personal resume website, read on to find how to build your own copy.
**The output files are just JavaScript and HTML.** 🤩
## Requirements
- [Node.js](https://nodejs.org/) (the most recent LTS version)
- [Yarn](https://yarnpkg.com/en/docs/install) (the most recent stable version)
- [Visual Studio Code](https://code.visualstudio.com/) for development.
## Development setup
Open Windows PowerShell and `cd` to the project directory, run:
### `yarn install`
This is one-time command to install all dependencies of the project. You will not run any other commands if the dependencies have not yet been installed.
### `yarn start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
## Production build
### `yarn build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
TLDR: The production needs to be run on a server although it does not contains server side script. This is because the build created filenames with the hashes and `%PUBLIC_URL%` paths. You might be interested in setting up a static server for testing the production. For environments using Node, the easiest way to handle this would be to install [serve](https://github.com/zeit/serve) and let it handle the rest:
```
yarn global add serve
serve -s build
```
## Dependencies
- [fortawesome](https://fontawesome.com/how-to-use/on-the-web/using-with/react)
- [node-sass](https://github.com/sass/node-sass)
- [react-bootstrap](https://react-bootstrap.github.io/)
- [react-countup](https://github.com/glennreyes/react-countup)
- [react-reveal](https://github.com/rnosov/react-reveal)
- [react-slick](https://github.com/akiran/react-slick)
- [react-text-loop](https://github.com/braposo/react-text-loop)
- [react-tsparticles](https://github.com/matteobruni/react-tsparticles)
- [react-visibility-sensor](https://github.com/joshwnj/react-visibility-sensor)
- [react](https://reactjs.org/)
- [slick-carousel](https://github.com/kenwheeler/slick)
- [smoothscroll](https://github.com/iamdustan/smoothscroll)
- [styled-components](https://github.com/DefinitelyTyped/DefinitelyTyped)
- [tslint](https://palantir.github.io/tslint/)
- [types/node](https://nodejs.org/)
- [typescript](https://www.typescriptlang.org/docs/handbook/react.html)