Duck Portfolio - Documentation

Be like a duck, paddling and working very hard inside the water, but what everyone sees is a smiling and calm face. ― Manoj Arora


Logo

Untitled Duck Project

EvolveU and Duck Labs present a PBL Experiment!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

This project is a collaboration between Duck Labs and EvolveU that aims to teach students the entirety of the spectrum of full-stack web development, starting with the visuals and UX of the front-end, and ending with the database and server communcation of the back-end, with the result being a complete and functional website.

Specifically, this work is meant to exemplify the pedagogy of Project-based Learning. PBL is an instructional methodology that encourages students to learn and apply knowledge and skills through an engaging experience. PBL presents opportunities for deeper learning in-context and for the development of important skills tied to career readiness.

Why Project-based Learning?

In essence, the PBL model consists of these seven characteristics:

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

For development, you will only need Node.js and a node global package, Yarn, installed in your environement.

Prerequisites

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/duck-project.git
$ cd duck-project
$ 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 - brennankbrown@pm.me

Project Link: https://github.com/brennanbrown/duck-project

Acknowledgements