https://github.com/fireisgood/fancy-text
A website to transform English text to fancy Unicode versions.
https://github.com/fireisgood/fancy-text
Last synced: about 1 year ago
JSON representation
A website to transform English text to fancy Unicode versions.
- Host: GitHub
- URL: https://github.com/fireisgood/fancy-text
- Owner: FireIsGood
- License: mit
- Created: 2024-03-11T08:08:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T06:07:52.000Z (over 2 years ago)
- Last Synced: 2025-02-18T01:42:00.820Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://fireisgood.github.io/fancy-text/
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fancy Text
A website to transform English text to fancy Unicode versions.
e.g. `Now this is epic -> 𝐍𝐨𝐰 𝐭𝐡𝐢𝐬 𝐢𝐬 𝐞𝐩𝐢𝐜`
The current version supports a few Mathematical Alphanumeric Symbols and some of the numbered variants. If you don't see a variant you want, [feel free to add it](#Contributing)!
## Running Locally
Instructions to run the project on your machine. If you just want to add a map, read about contributing below.
### Prerequisites
Read the [Astro quick start guide's prerequisite list](https://docs.astro.build/en/install/manual/#prerequisites).
This project uses pnpm. You can check that pnpm is installed in the terminal by running:
```bash
pnpm -v
```
### Setup
First, [fork the repo](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
Once the prerequisites are installed and you are working off the fork, [clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) to your local machine.
This can be done from the command line:
```bash
git clone git@github.com:FireIsGood/fancy-text.git ./fancy-text
```
### Local Development
You can run the development server through the terminal. The default port is
1625 because I thought it was a funny number, but you can change it with the
`--port` flag.
From the command line:
```bash
# Default port 1625
pnpm dev
# Custom port
pnpm dev --port 1234
```
When Astro is done setting up, you should see a success message.
```bash
┃ Local http://localhost:1625/
┃ Network use --host to expose
```
There are additional commands you can run from the terminal:
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:1625` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro -- --help` | Get help using the Astro CLI |
## Contributing
Pull requests for add additional maps are welcome! You can find all the maps in the [/src/scripts/maps.ts](https://github.com/FireIsGood/fancy-text/blob/main/src/scripts/maps.ts) file along with a small example and directions.
If you want to add features, please [open an issue](https://github.com/FireIsGood/fancy-text/issues) before making a pull request.
Please **do not build in pull requests**, as that can cause issues with the automatic
merging.
## License
[MIT](https://choosealicense.com/licenses/mit/)