The open-components-hackathon-website from unfoldingword

Open Components Hackathon Website

Website for Open Components Hackathon Events by unfoldingWord Developers.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

Purpose

The purpose of this project

Problem

The problem statement

Scope

What's in scope and out of scope for this project?

Background

What led us to this point? How did we get here?

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Data what is the source of the data and data formats are covered by this project?

This is an example of how to list things you need to use the software and how to install them.

npm
```
npm install npm@latest -g
```

Installation/First Steps

Get a free API Key at https://example.com

Clone the repo

git clone https://github.com/unfoldingWord/open-components-hackathon-website.git

Install NPM packages
```
npm install
```
Enter your API in config.js
```
const API_KEY = 'ENTER YOUR API';
```

(back to top)

Usage/Integration

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more details, please refer to the virtual-event-starter-kit Documentation

Styleguidist link

(back to top)

Roadmap

[] Feature 1
[] Feature 2
[] Feature 3
- [] Nested Feature

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

(back to top)

Contributing

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

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.