Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
takaneichinose committed Nov 4, 2021
1 parent c424012 commit 8d6b2d4
Showing 1 changed file with 37 additions and 8 deletions.
45 changes: 37 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,47 @@

## Description

This is the distributed repository of my home page.
This is the distributed repository of my profile home page.

This is not yet completely finished, but most of the functions, and the information can be seen.
To see the actual distributed program, please visit my homepage from Github Pages: [https://takaneichinose.github.io](https://takaneichinose.github.io).

I created my home page using [ReactJS](https://reactjs.org/).
This is the repository of the main source code. [https://github.com/takaneichinose/profile](https://github.com/takaneichinose/profile)

All the images are created using [Aseprite](https://www.aseprite.org/).
The main concept of my homepage is like a game. The UI is like retro game with pixellated images. The messagebox is like a speech dialog which is common in retro RPG game.

## Source code
You can click anywhere on the floor to move the character. Although movement of character is meaningless, I just want to show the animation of the character while moving. The movement has also an algorithm where the character avoids an object with collision on it.

The files in this repository are just the distributed files from my other repository. If you would like to see the main source code, please look at my [Profile](https://github.com/takaneichinose/profile) repository.
There are few interactable objects in this game.

## Link to my home page
1. Files -> To view my resume
2. Laptop -> To open my blog
3. Top-right hamburger -> To open the main menu

https://takaneichinose.github.io/
## Building the program

For my future reference, below is the way in how to build the program.

1. Clone the repository
2. Optional: Install [yarn](https://yarnpkg.com/) as package manager
3. Install the dependencies using yarn ``` # yarn ``` or using npm ``` # npm install ```
4. Build the main program using yarn ``` # yarn build ``` or using npm ``` # npm run build ```
5. At the step above, the distributed program will be produced, and _dist_ folder will be generated. The step from here will be optional if you want to run the program on the localhost.
6. Create a local virtual server using yarn ``` # yarn start ``` or using npm ``` # npm start ```.
7. After building, usually it can accessed at [http://localhost:1234/](http://localhost:1234/).

## Resources

1. [ReactJS](https://reactjs.org/) JavaScript framework
2. [Aseprite](https://www.aseprite.org/) Image creation software
3. [Parcel](https://parceljs.org/) Package manager
4. [TypeScript](https://www.typescriptlang.org/) JavaScript transpiler
5. [Redux](https://redux.js.org/) State management library
6. [yarn](https://yarnpkg.com/) Package manager
7. [npm](https://www.npmjs.com/) Initial package manager
8. [NodeJS](https://nodejs.org/en/) JavaScript used for building
9. [Sass](https://sass-lang.com/) or SCSS for CSS framework
10. [pug](https://pugjs.org/api/getting-started.html) For HTML template engine

## Link to my homepage

[https://takaneichinose.github.io/](https://takaneichinose.github.io/)

0 comments on commit 8d6b2d4

Please sign in to comment.