Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/techprimers/techprimers.github.io

Source code for http://techprimers.github.io
https://github.com/techprimers/techprimers.github.io

contribution first-contribution first-opensource-contribution hugo opensource techprimers

Last synced: 7 days ago
JSON representation

Source code for http://techprimers.github.io

Awesome Lists containing this project

README

        

# TechPrimers Open Source

[![Build Status](https://travis-ci.com/TechPrimers/techprimers.github.io.svg?branch=master)](https://travis-ci.com/TechPrimers/techprimers.github.io)
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![GitHub stars](https://img.shields.io/github/stars/techprimers/techprimers.github.io.svg)](https://github.com/techprimers/techprimers.github.io/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/techprimers/techprimers.github.io.svg)](https://github.com/techprimers/techprimers.github.io/network)
[![GitHub issues](https://img.shields.io/github/issues/techprimers/techprimers.github.io.svg)](https://github.com/techprimers/techprimers.github.io/issues?q=is%3Aissue+is%3Aopen)
[![Contributors](https://img.shields.io/github/contributors/techprimers/techprimers.github.io.svg)](https://github.com/techprimers/techprimers.github.io/graphs/contributors)

This repository is the source code of https://techprimers.github.io/public

This repo contains:
- Conferences Links `/content/conferences`
- New Open Source Contributors `/content/contributors`

This is a opensource repository which you can fork.
Raise a Pull Request by adding your name to get featured in https://techprimers.github.io/public/contributors/

Youtube video on [Hugo Example](https://www.youtube.com/watch?v=yjdJGhV6gbg)

## Contributors

This project exists thanks to all the people who contribute.


Made with [contributors-img](https://contributors-img.web.app).

## Online Edit
[![Edit with Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TechPrimers/techprimers.github.io)

## Checkout
The below steps are for checking out this codebase.
```
git clone https://github.com/TechPrimers/techprimers.github.io.git techprimers-repo
cd techprimers-repo
git submodule init
git submodule update
```

## Add your name
Add your name with a new markdown file under `/content/contributors/` folder along with content similar to `ajaykumars.md` file.

## Install Hugo
You need [hugo](https://gohugo.io/) to create the Static HTML files based on the markdown files(*.md) which we have created.
Steps for installing hugo can be followed from [here](https://gohugo.io/getting-started/installing/)

## Run the site locally
You can run the site locally and see how the pages are reflected before committing/pushing the code.
```
cd techprimers-repo
hugo serve -D
```
This command will help in Live reloading of website once we update the Markdown files.
The site will be available at [http://localhost:1313](http://localhost:1313)

## Creating final Static files
Run the `hugo` command to create static files under `public/` folder.
```
cd techprimers-repo
hugo
```
Commit the `public` folder along with your markdown file and raise a pull request. -> This process is now automated using [Travis CI](https://travis-ci.com/TechPrimers/techprimers.github.io).

Feel free to just add the `.md` file alone.

## Motivation
Contribution brings happiness to world!