Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jhubbardsf/crossmint-technical

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/jhubbardsf/crossmint-technical
Owner: jhubbardsf
Created: 2024-08-20T12:52:58.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-08-20T22:21:52.000Z (6 months ago)
Last Synced: 2025-02-04T19:45:31.158Z (17 days ago)
Language: TypeScript
Size: 1.6 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        







  

    

  

Crossmint Technical


  


    Technical takehome for Crossmint.io

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contact

  


## About The Project

![Product Name Screen Shot][product-screenshot]

![Goal Map][goalmap-screenshot]

This is a command line tool to build out the Crossmint Technical Challenge

Megaverse according outlined in the goal for the phase that the candidate is currently in. It will

populate your map automatically from the goal map and can also destroy the map incase

you want to test building it up and down (note: it will only delete objects that

were placed there according to the goal map).

(back to top)


### Built With

* [![Bun][Bun.sh]][Bun-url]

* [![Typescript][Typescriptlang.org]][Typescriptlang-url]

(back to top)


## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites

* Bun

  ```sh

  npm install -g bun

  ```

(back to top)


### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/jhubbardsf/crossmint-technical.git

   ```

2. Create your `.env` file from example

    ```sh

    cp .env.example .env

   ```

3. Enter your candidateId in `.env`

   ```env

   CANDIDATE_ID='YOUR CANDIDATE ID';

   ```

(back to top)


## Usage

After following installation instructions you can have the application populate

your megaverse based on your candidate goal map and also destroy the megaverse

to blank out your candidate map.

### Build Megaverse

```sh

bun run src/entry.ts

```

### Destroy Megaverse

```sh

bun run src/entry.ts --destroy

```

or

```sh

bun run src/entry.ts -d

```

(back to top)


## Roadmap

- [X] Build out rough app structure

- [X] Get App talking to API

- [X] Test Phase 1

- [X] Extend builder for more shapes for Phase 2

- [X] DRY out code

- [ ] Add some tests

- [ ] Submit

See the [open issues](https://github.com/jhubbardsf/crossmint-technical/issues) for a full list of proposed features (and known issues).

(back to top)


## Contact

Josh Hubbard - [email protected]

Project Link: [https://github.com/jhubbardsf/crossmint-technical](https://github.com/jhubbardsf/crossmint-technical)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/jhubbardsf/crossmint-technical.svg?style=for-the-badge

[contributors-url]: https://github.com/jhubbardsf/crossmint-technical/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/jhubbardsf/crossmint-technical.svg?style=for-the-badge

[forks-url]: https://github.com/jhubbardsf/crossmint-technical/network/members

[stars-shield]: https://img.shields.io/github/stars/jhubbardsf/crossmint-technical.svg?style=for-the-badge

[stars-url]: https://github.com/jhubbardsf/crossmint-technical/stargazers

[issues-shield]: https://img.shields.io/github/issues/jhubbardsf/crossmint-technical.svg?style=for-the-badge

[issues-url]: https://github.com/jhubbardsf/crossmint-technical/issues

[license-shield]: https://img.shields.io/github/license/jhubbardsf/crossmint-technical.svg?style=for-the-badge

[license-url]: https://github.com/jhubbardsf/crossmint-technical/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/jhubbardsf

[product-screenshot]: images/commandline.png

[goalmap-screenshot]: images/megaverse.png

[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white

[Next-url]: https://nextjs.org/

[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB

[React-url]: https://reactjs.org/

[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D

[Vue-url]: https://vuejs.org/

[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white

[Angular-url]: https://angular.io/

[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00

[Svelte-url]: https://svelte.dev/

[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white

[Laravel-url]: https://laravel.com

[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white

[Bootstrap-url]: https://getbootstrap.com

[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white

[JQuery-url]: https://jquery.com 

[Bun.sh]: https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white

[Bun-url]: https://bun.sh

[Typescriptlang.org]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white

[Typescriptlang-url]: https://typescriptlang.org