Handbook

Introduction

The CodeLab Handbook is, primarily, a repository of all relevant information about CodeLab, an universitary extension group which aims to stimulate technological innovation. Here you can find more information about the group, initiatives, projects, internal organization and much more. Although it was created to improve the onboarding experience of new members, the Handbook is open for everyone to read :)

Getting Started

Prerequisites

This project was created using VuePress v1.2, which is a static site generator and part of the VueJS ecossystem. Here is the list of prerequisites:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed;
• NodeJS: Download & Install Node.js and the npm package manager. Be aware that VuePress 1.2 requires NodeJS >= 8.6;
• Docker + Docker Compose (optional): Download & Install Docker and Docker Compose in order to use an alternative way to run this project.

Installing

Run the following command on your terminal of choice to install the necessary dependencies (you may skip this step if you're using Docker and Docker Compose):

# on the root directory of this project, the same as package.json and package-lock.json
npm install

Run using npm

Run the following command on your terminal of choice to run the application. By default, it sets up a server on localhost:8080.

npm run docs:dev

Run using Docker and Docker Compose

Alternatively, we also provide a Dockerfile and a docker-compose.yml. Run the following commands on your command-line to build an image and setup a container running the application. By default, it binds the container's port 8080 to localhost:8080.

docker-compose build
docker-compose up

Add new content!

That's it! The application should be up and running 🚀🚀. You can edit the Markdown files inside the .docs/ directory and see your changes at localhost:8080.

If you want to contribute, checkout the following section.

Contributing

We are open for contributions :)

Please checkout our Contributing Guide for more information on how to propose improvements. Also, see our issues board if you're looking for ideas on how to contribute.

License

Please, checkout our License

Contributors

Ricardo Kojo

João Daniel

Leandro Rodrigues

Ygor Tavela

Fernando Freire