Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<!-- |Light Theme | [GitHub](https://github.com/kelvinkamau/Vibranium) | [Preview](https://kelvinkamau.github.io/Vibranium) | -->


# Running it locally 🔩
* You might need to have [NPM](https://nodejs.org/en/download/) or [yarn](https://yarnpkg.com/en/docs/install)
* In the project directory, run `npm install` or `yarn install` depending on which you have
* Then run `npm run dev` and open your browser to `http://localhost:8080` to start working on the project
* To build the project run `npm run build`

## Tech Stack
* HTML
* CSS
* JS

## Contributing
Project Vibranium is an open source software project and I encourage developers to contribute patches and code for us to include in the main package of Project Vibranium. All contributions will be fully credited.

Expand Down