creativecommons / creativecommons/cc-resource-archive

[Feature] Include links to tutorials and references for the technology dependencies required to set up the project locally

Open
#55 9 comments 0 reactions 1 assignee Claimed by @TimidRobot View on GitHub
✨ goal: improvement 🏁 status: ready for work 🤖 aspect: dx 🟩 priority: low
Dominant language
Dockerfile
Stars
66
Forks
137
PR merge metrics
No merged PRs in 30d

Description

## Problem
It's very confusing and time taking process of setting up the project locally and hosting it on a local host.

## Description
Based on my understanding of the problem and the user's perspective, I suggest the addition of a set by step procedure of local hosting of the website. By this feature, we eliminate confusion. This could increase clarity, improve usability, or a better overall user experience. I personally spent an hour trying to understand how to set up the project locally. It could enhance user engagement and motivates them to work on things that truly matters rather than just being on setting up.

## Alternatives
**An alternative solution can be docker , but based on my understanding**
Setting up GitHub Pages using Jekyll can be better than using Docker for a few reasons:

Simplicity: GitHub Pages and Jekyll are relatively straightforward to set up and use. Jekyll is a static site generator that allows you to create a website from plain text files, and GitHub Pages is a hosting service that allows you to publish your Jekyll site to the web. Docker, on the other hand, is a more complex tool that requires additional knowledge and configuration.

Cost: GitHub Pages is free, while Docker requires you to set up and maintain your own server infrastructure, which can be expensive.

Maintenance: With GitHub Pages and Jekyll, you don't have to worry about maintaining server infrastructure, as GitHub takes care of that for you. With Docker, you would need to ensure that your server infrastructure is up to date and secure.

Version control: GitHub Pages is tightly integrated with Git, so you can easily version control your website and collaborate with others. Docker, on the other hand, doesn't have the same level of integration with Git.

## Implementation

- [x] I would be interested in implementing this feature.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.