devfolio/README.md

27 lines
1.3 KiB
Markdown
Raw Normal View History

2019-08-16 01:33:25 +00:00
# devfolio
2019-08-17 01:44:38 +00:00
A simple, responsive, single-page portfolio for developers built with Bulma, Sass and Font Awesome.
2019-08-22 01:01:10 +00:00
2019-08-24 01:41:00 +00:00
View the [demo here](https://mmacneil.github.io/devfolio/).
2019-08-24 01:35:45 +00:00
2019-08-26 00:11:32 +00:00
### Desktop version
2019-08-26 00:03:07 +00:00
<img src="https://github.com/mmacneil/devfolio/blob/master/docs/devfolio-desktop.gif" />
2019-08-26 00:11:32 +00:00
### Responsive version
<img src="https://github.com/mmacneil/devfolio/blob/master/docs/devfolio-responsive.gif" />
2019-08-24 01:35:45 +00:00
## Setup
1. Clone or fork this repository.
2. Install required dependencies from your terminal by running `npm install` from the project folder root containing `package.json`.
2019-08-24 01:36:24 +00:00
<pre>
2019-08-24 01:41:00 +00:00
<code>src\>npm install</code></pre>
2019-08-24 01:47:33 +00:00
3. Use webpack to compile and bundle the css/js by running `npm run build` from the project folder root containing `webpack.config.js`. Webpack will also begin watching these files for changes and re-build as they're modified.
<pre>
<code>src\>npm run build</code></pre>
2019-08-24 01:54:17 +00:00
4. Open `index.html` locally in your favorite browser.
2019-08-24 01:57:25 +00:00
5. Modify accordingly - styles, colors and variables can be changed in `styles.scss`. Refer to the Bulma docs for guidance on how to quickly customize further to suit your tastes using [color helpers](https://bulma.io/documentation/modifiers/color-helpers/) and [variables](https://bulma.io/documentation/customize/variables/).
## Contact
markmacneil@gmail.com
2019-08-24 01:54:17 +00:00