38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
## giovani.lol
|
|
|
|
This website was created for the purpose of learning how to use React. It contains information about myself and my experience. ~~It is currently deployed and can be viewed at [giovani.lol](https://giovani.lol).~~
|
|
|
|
## Demo
|
|
|
|
<p align="center">
|
|
<img src="https://gitea.redturtle.foo/crayonix/giovani.lol/raw/branch/master/readme/demo.gif">
|
|
</p>
|
|
|
|
## Run Project
|
|
|
|
To run this project you will need to make sure `npm` and Node are installed on your computer. For more information an how to install `npm` and Node go [here](https://nodejs.org/en/download/).
|
|
|
|
From the terminal:
|
|
|
|
```bash
|
|
# clone the repository using git
|
|
$ git clone https://gitea.redturtle.foo/crayonix/giovani.lol
|
|
|
|
# move into cloned repository directory
|
|
$ cd giovani.lol
|
|
|
|
# install all dependencies using npm
|
|
$ npm install
|
|
|
|
# run npm command to start project
|
|
$ npm start
|
|
```
|
|
|
|
Following the above will run the project in development mode and will open a browser to [http://localhost:3000](http://localhost:3000) to view the website.
|
|
|
|
## Contributing
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
## License
|
|
[MIT](https://choosealicense.com/licenses/mit/)
|