Updated README.md

This commit is contained in:
Ronnie 2024-11-20 19:30:22 -05:00
parent 90ed7aede2
commit 830122d0d8

108
README.md
View file

@ -1,36 +1,108 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). # Ronniie.dev
## Getting Started A fully interactive, terminal-style web application built with **Next.js**. This project features dynamic social links, self-hosted tools, command history navigation, and a stylish welcome message.
First, run the development server: ---
## Features
- **Interactive Terminal:**
- Accepts user input commands like `help` and `socials`.
- Supports command history navigation with `↑` and `↓` arrow keys.
- **Dynamic MOTD (Message of the Day):**
- Includes a welcome message with styled text.
- Highlights developer information and self-hosted services.
- **Command List:**
- `help`: Displays a list of available commands.
- `socials`: Displays links to GitHub, YouTube, Discord, Reddit, and BlueSky profiles.
- More coming soon!
- **Tech Stack:**
- **Next.js** for SSR and frontend.
- **React Icons** for elegant icons.
- **TailwindCSS** for modern styling.
---
## Installation
Follow these steps to set up and run the project locally:
### Prerequisites
- [Node.js](https://nodejs.org/) (version 16 or higher)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Clone the Repository
```bash
git clone https://github.com/Ronniie/ronniie.dev.git
cd ronniie.dev
```
### Install Dependencies
```bash
npm install
# or
yarn install
```
---
## Usage
### Development Server
To start the development server, run:
```bash ```bash
npm run dev npm run dev
# or # or
yarn dev yarn dev
# or
pnpm dev
# or
bun dev
``` ```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. The application will be available at [http://localhost:3000](http://localhost:3000).
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. ---
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. ## Styling
## Learn More This project uses **TailwindCSS** for styling. The terminal has a dark theme with highlighted text elements to provide a sleek and modern appearance.
To learn more about Next.js, take a look at the following resources: ### Tailwind Configuration
To customize the styles, edit the `tailwind.config.js` file.
- [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! ## Dynamic Icons
## Deploy on Vercel Dynamic importing of icons from `react-icons` ensures minimal client-side overhead. The following icons are used:
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. - **Socials:**
- GitHub, BlueSky, Discord, YouTube, Reddit
- **Self-Hosted Services:**
- Docker, Plex, Proxmox, Home Assistant, Paperless-ng
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. ---
## Contributing
If you'd like to contribute:
1. Fork the repository.
2. Create a feature branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m "Add feature-name"`.
4. Push to the branch: `git push origin feature-name`.
5. Open a pull request.
---
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
---
Enjoy using the terminal and let me know how it works for you! 🚀