Mark/esolang
1
0
Fork 0
Code Issues Packages Activity

Update project readme

Browse Source
This commit is contained in:
Nilay Majorwar 2022-02-19 22:24:00 +05:30
parent a8d6756f5e
commit 61d2a5f241
1 changed files with 28 additions and 27 deletions

55
README.md

@ -1,34 +1,35 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Esolang Park
## Getting Started
Esolang Park is an **online interpreter and debugger** catered for **esoteric programming languages**. Think Repl.it, but a more simplified version for esoteric languages, with a visual debugger catered to each language, that runs on your own device.
First, run the development server:
The goal of Esolang Park is to be a platform for esolang enthusiasts to test and debug their code more easily, as well as for other people to discover and play around with esoteric languages without leaving the browser.
```bash
npm run dev
# or
yarn dev
For every esolang, Esolang Park provides the following features:
- Powerful Monaco code editor
- Syntax highlighting
- Live syntax checking in the editor
- Set breakpoints in your code
- Pause and step through code execution at any time
- Adjust the speed of execution
- View the runtime's internal state during execution
Code for the core app is **completely decoupled** from the esolang runtime - adding the runtime for a new esoteric language is just writing code that implements a standard API. This allows developers to create a development environment for an esolang without worrying about the common details of text editor, error handling, debugging and input-output.
## Building the app
Esolang Park is a [Next.js](https://nextjs.org) application built with TypeScript. To run Esolang Park locally, you need to have a modern version of [Node.js](https://nodejs.org) installed. This project uses [Yarn](https://yarnpkg.com/) as its package manager, so you need that too.
Once you've cloned the repository locally, run the following commands and then navigate to http://localhost:3000 on your browser:
```sh
yarn # Install project dependencies
yarn build:worker # Build the esolang worker scripts
yarn dev # Run the development server
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
If you're interested in modifying the source code of the language providers, run `yarn dev:worker` in a separate terminal window. This starts the webpack watcher on language provider source code.
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
## Adding new esolangs
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
If you want to add new esolangs to the project, create an issue. Or you can also implement it yourself, if you're comfortable with TypeScript and a bit of React. The wiki contains a guide to implementing a language provider for Esolang Park.