Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #10

Merged
merged 4 commits into from
Jun 15, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 84 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,89 @@
# token-website
# [token.langx.io](https://token.langx.io)

Official Website for the [token.langx.io](https://token.langx.io)
[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/wm9t.svg)](https://status.langx.io)

## Development Status
Welcome to the LangX Token webpage! Our app, in addition to helping you learn a new language through practice and immersion with native speakers from around the world, will give you the opportunity to earn with our unique "Learn-to-Earn" initiative. This is where you can find out everything you need to know about this initiative.

Our "Coming Soon" page has been released! The full project is still under development and the first major release has not yet been launched.
This webpage is built with HTML, CSS and JavaScript.

Please stay tuned for updates and progress.
## Table of Contents

We appreciate your patience and interest.
- [Prerequisites](#prerequisites)
binbang12 marked this conversation as resolved.
Show resolved Hide resolved
- [Getting Started](#getting-started)
- [Development Server](#start-development-server)
xuelink marked this conversation as resolved.
Show resolved Hide resolved
- [Issues](#issues)
- [Stargazers](#stargazers)
- [Contributors](#contributors)
- [License](#license)

## Setup

### Prerequisites

Before you begin, please make sure you have met the following requirements.

- You have installed [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) (Node Package Manager).
- You have a [GitHub](https://github.com/) account

binbang12 marked this conversation as resolved.
Show resolved Hide resolved
### Getting Started

1. Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of the repository page.


2. Clone the repository (Open your terminal and run the following commands).

```bash
# clone the repository
git clone https://github.com/your-username/token-website.git

# Make sure you replace "your-username" with your GitHub username
```

3. Navigate to the project directory

```bash
# navigate to the projects directory
cd token-website
```

4. Install dependencies
binbang12 marked this conversation as resolved.
Show resolved Hide resolved

```bash
npm install
```

## Start Development Server
binbang12 marked this conversation as resolved.
Show resolved Hide resolved

Once you've created your project and installed dependencies with `npm install`, you can start a development server:

```bash
npm run dev

# or start the server and open the app in a new browser tab

npm run dev -- --open
```

## Issues

If you encounter any issues, ensure that your [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) versions are up to date.
binbang12 marked this conversation as resolved.
Show resolved Hide resolved

## Contributing

We welcome contributions from the community! If you'd like to contribute to the LangX Token webpage, please fork our repository, make some improvements, and submit a pull request. We'll review your changes and merge them if they meet our guidelines. Thank you for helping to make this page even better!

LangX is an open source project and we welcome contributions from the community. If you're interested in contributing, please check out our GitHub repository for more information.

### Stargazers

[![Stargazers over time](https://starchart.cc/langx/token-website.svg?variant=adaptive)](https://starchart.cc/langx/token-website)

### Contributors

[![GitHub Contributor Over Time](https://contributor-overtime-api.git-contributor.com/contributors-svg?chart=contributorOverTime&repo=langx/token-website)](https://git-contributor.com?chart=contributorOverTime&repo=langx/token-website)

[![GitHub Contributors Image](https://contrib.rocks/image?repo=langx/token-website)](https://github.com/langx/token-website/graphs/contributors)

## License

The LangX Token webpage is released under the [BSD 3-Clause "New" or "Revised" License](./LICENSE). If you use this project, please include the license file in your distribution.