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

https://github.com/hatixntsoa/github.codespace

Simple setup scripts for Git config and timezone, optimized for GitHub Codespaces.
https://github.com/hatixntsoa/github.codespace

git-config github-codespaces shell-scripts timezone

Last synced: 18 days ago
JSON representation

Simple setup scripts for Git config and timezone, optimized for GitHub Codespaces.

Awesome Lists containing this project

README

          

# GitHub Codespace πŸš€


GitHub Codespace Setup Logo

`github.codespace` is a project aiming to automate startup script that instantly configures your **GitHub Codespace environment** β€” no manual setup required.
It helps you quickly set your **timezone** and **Git credentials** on every new session in just one command.



License: MIT


Project Status


Hosted on GitHub Pages

### Contents

[Quick Start](#quick-start-) |
[Screenshot](#screenshot-) |
[Project Structure](#project-structure-) |
[How It Works](#how-it-works-) |
[Deployment](#deployment-) |
[License](#license-)


## Quick Start ⚑

To configure your Codespace environment instantly, run this single command in your terminal:

```bash
curl -sL codespace.hatixntsoa.site | bash
````

You’ll be prompted to enter:

* Your **timezone offset** (e.g., `3` for GMT+3)
* Your **Git username**
* Your **Git email**

Once complete, the script will:

* Set your system’s timezone accordingly
* Configure your Git credentials locally within the Codespace


## Screenshot πŸ“Έ


Gemini Chat TUI running in terminal


Example: Script Execution inside a GitHub Codespace Terminal session.


## Project Structure πŸ“¦

```
.
β”œβ”€β”€ setup/
β”‚ β”œβ”€β”€ git.creds.sh # Sets up Git username and email
β”‚ β”œβ”€β”€ timezone.sh # Configures system timezone
β”‚ └── startup.sh # Main startup script (alias: index.html)
β”œβ”€β”€ CNAME # Custom domain for GitHub Pages
β”œβ”€β”€ index.html # Serves bash or web content depending on context
β”œβ”€β”€ LICENSE.md
└── README.md
```


## How It Works πŸ”§

The startup script (`index.html`) performs the following actions:

1. **Fetches and runs `timezone.sh`**

* Applies your timezone based on offset input (e.g., `Etc/GMT-3`).
2. **Fetches and runs `git.creds.sh`**

* Configures `user.name` and `user.email` for Git locally in the Codespace.

You can view the raw script here:
πŸ‘‰ [https://codespace.hatixntsoa.site](https://codespace.hatixntsoa.site)


## Deployment 🌐

This project is hosted via **GitHub Pages** with a [custom domain](https://codespace.hatixntsoa.site).

All scripts inside the `setup/` directory are public and accessible at:

```
https://codespace.hatixntsoa.site/setup/
```

**Examples:**

* [git.creds.sh](https://codespace.hatixntsoa.site/setup/git.creds.sh)
* [timezone.sh](https://codespace.hatixntsoa.site/setup/timezone.sh)


## License πŸ›‘

This project is licensed under the **MIT License**.
See the [LICENSE.md](LICENSE.md) file for details.