Brennan's Portfolio

My current web portfolio, built with Express and Node.js
Explore the docs »

View Site · Report Bug · Request Feature

Table of Contents:

• About The Project
• Getting Started
  • Prerequisites
• Installation
  • Running the project
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements and Resources

About The Project

This is my portfolio, showcasing my work as a web developer and writer. Featuring my most recent coding projects, blog posts, and how best to contact me if you're interested in collaboration! It is a single-page design, with emphasis on typography and accessibility. It's based off of an older project I did, Duck Project.

This website is built with:

• Bootstrap 4
• node.js
• express
• EJS

Getting Started

If you're curious about downloading and using this as a template for your own work, then for development, you will only need Node.js and NPM installed in your environement.

Prerequisites

• Node installation on Windows

  Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

• Node installation on Ubuntu

  You can install nodejs and npm easily with apt install, just run the following commands.

  $ sudo apt install nodejs
  $ sudo apt install npm
  

• Other Operating Systems

  You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v8.11.3

$ npm --version
6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

Installation

$ git clone https://github.com/brennanbrown/portfolio.git
$ cd portfolio
$ npm i

Running the project

$ npm start

Once the server has started up, you can visit it at localhost:3000/, or 127.0.0.1:3000/.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Brennan K. Brown - @brennankbrown - mail@brennanbrown.ca

Project Link: https://github.com/brennanbrown/portfolio

Acknowledgements and Resources

Project Management:

• README Template
• Prettify
• ESLint
• auto0 .gitignore
• Favicon.io
• Img Shields
• Choose an Open Source License

Design:

• GitHub Emoji Cheat Sheet
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome
• Icons8 Upscaler