Git Product home page Git Product logo

handbook's Introduction

Logo USPCodeLab Handbook

UCL Butantã Custom Badge UCL Leste Custom Badge UCL Sanca Custom Badge

Status Rocket Custom Badge GitHub package.json dependency version (dev dep on branch) PRs Welcome

GitHub forks Twitter Follow

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:

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

GitHub issues GitHub contributors

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
Ricardo Kojo
João Daniel
João Daniel
Leandro Rodrigues
Leandro Rodrigues
Ygor Tavela
Ygor Tavela
Fernando Freire
Fernando Freire

handbook's People

Contributors

jooaodanieel avatar leandrigues avatar ricardokojo avatar wanderdasouza avatar ygortavela avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

handbook's Issues

Contact with rectory

USP Rectory is divided into a list of offices. It would be nice to have a section exibing all contacts we have with the rectory and with each office, under > relação com a USP > reitoria e pró-reitorias > contato

Resumo dos acrônimos

  1. CLI - CodeLab Initiative
  2. CLASS - CodeLab Association
  3. CLAP - CodeLab Access Point
  4. CLUB - CodeLab University Bureau
  5. LUH - Liga Universitária de Hackathon

Mascote: Cloreto

Add License

  • Add a LICENSE file
  • Add LICENSE section to README.md
  • Update LICENSE badge at README.md to redirect to LICENSE file

Make a PWA

It would be nice if the handbook was quickly accessible for a person.
A mobile app would be nice, thus a PWA config for VuePress seems the perfect solution.

Discord 101

Coisinhas básicas mas importantes do discord:

  • O mínimo do mínimo de markdown p/ quem não sabe (ou o fato de que se pode usar md no discord)
  • Como organizamos votações de perguntas binárias e múltipla escolha
  • To be continued...

Explicação da dev.journey

  1. dev.learn()
  2. dev.boost()
  3. dev.hack()
  4. dev.hire()
  5. dev.camp()
  6. dev.research()

OBS: versão staff mesmo ("dev.learn é aula para fora, mas para dentro é organizar aula, tirar dúvida, lista de presença etc")

Relation with the rectory

USP Rectory is divided into a list of offices. It would be nice to have a section exibing all the history with that office (the relation), under > relação com a USP > reitoria e pró-reitorias > relação

Create README.md

Create a README.md at root directory of this repository with basic information about the project, instructions to run the project locally, contributors list, etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.