Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohammad N authored Jan 6, 2024
1 parent a808c06 commit 006d57d
Showing 1 changed file with 55 additions and 23 deletions.
78 changes: 55 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,70 @@
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).

## Getting Started
# BaseSwap Decentralized Exchange

First, run the development server:
Welcome to BaseSwap, a decentralized exchange application developed by NILL Developers.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
## Project Overview

BaseSwap is a cutting-edge decentralized exchange (DEX) built on the principles of transparency, security, and user-centric design. Empowering users to trade digital assets seamlessly on the blockchain, BaseSwap offers a decentralized and secure trading experience.

## Developers

Developed with passion and expertise by the NILL Developers team:

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- Mohammad Nazari (Frontend developer)
- Peyman Kalani (UI/UX designer)
- Mohsen Salehi (Frontend developer)
- Fardin Turkaman (Blockchain developer)

You can start editing the page by modifying `pages/SwapView.tsx`. The page auto-updates as you edit the file.
## How to Run

[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`.
### Prerequisites

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.
- Node.js installed
- npm package manager

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
### Steps

## Learn More
1. **Clone the Repository:**
```bash
git clone https://github.com/nilldevelopers/baseswap.git
cd baseswap
```

To learn more about Next.js, take a look at the following resources:
2. **Install Dependencies:**
```bash
npm install
```

- [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.
3. **Run Locally:**
```bash
npm run dev
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
The application will be accessible at `http://localhost:3000`.

## Deploy on Vercel
## Building for Production

To build the application for production:

```bash
npm run build
```

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.
This will generate optimized production-ready assets in the `out` directory.

## Contributing

We welcome contributions from the community. If you'd like to contribute to BaseSwap, please review our [Contribution Guidelines](CONTRIBUTING.md).

## Issues and Feedback

If you encounter any issues or have feedback, please create an [issue](https://github.com/nill-developers/baseswap/issues).

## License

This project is licensed under the [MIT License](LICENSE).

Happy Trading with BaseSwap! 🚀🌐
```
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

0 comments on commit 006d57d

Please sign in to comment.