Behold, make your own research project website in modern way.
⚜️ ⚜️ ⚜️
In the project directory, you can run:
-
Setup the enviroment
yarn install // or npm install
-
Run the development environment
yarn start // or npm start
The page opened in http://localhost:3000 will reload if you make edits. You will also see any lint errors in the console.
Put all your result images under the
public/
and with the correct path. -
Pack for production
yarn build // or npm run build
Build the app for production and output to the
build
folder. It correctly bundles React in production mode and optimizes the build for the best performance. -
Pack for production
Deploy the
build
folder to Github Page. The URL of page will behttp://{username}.github.io/{repo-name}
whereusername
is your Github username andrepo-name
is your Github repositary.-
Edit
"homepage"
entry in thepackage.json
."homepage": "http://{username}.github.io/{repo-name}"
-
Deploy to the
gh-pages
branch of your repositary can specified by additional argument-r
.yarn deploy -r {your-repo-github-url} // or npm run deploy -r {your-repo-github-url}
-
-
Develop with linter and prettier
We use
eslint
andprettier
to keep the source great!yarn lint yarn lint --fix // or npm run lint npm run lint --fix