Gavin-OP.github.io (Gavin's Website & Notes System)

Gavin's personal website and notes system, built using ReactJS, HTML, CSS, NodeJS, and Markdown. This repository contains the design, documentation, and implementation of the website and notes.

Table of Contents

• Install
• Usage
• Deployment
• Todo List
• References
• Contributing
• License

Install

1. Install NodeJS, npm and Git.

2. Open command prompt (terminal) in the directory where you want to install this repository (i.e. Gavin-OP.github.io).

3. Clone the repository using following command in command prompt (terminal).

   git clone https://github.com/Gavin-OP/Gavin-OP.github.io.git

Usage

1. Open command prompt (terminal) inside the cloned repository.

2. Install all required dependencies by running:

   npm install

3. Configure the project by setting up environment variables in a .env file. The content in the .env file can be:

   GITHUB_APP=<your token>

4. Start the website locally by running:

   npm start
   

Deployment

Pushing changes to the master branch will automatically trigger the build process. The website will be built and the output will be pushed to the gh-pages branch, which will then deploy the website. **Ensure that all changes are thoroughly tested before pushing to master.

Todo List

• Design the website layout, what should be included?¹
• Add a NodeJS backend server to serve all the files.²

References

25 React Website Design Examples We Love
How To Create A Website Like Apple

Contributing

Contributions are welcome! PRs and issues are gladly accepted. Notes System NEED contributors!!

License

MIT License

Footnotes

1. reference How to jazz up your website like Apple with JavaScript ↩

2. reference How to Create a React App with a Node Backend: The Complete Guide ↩