Skip to content

Commit

Permalink
📝 - Update Readme (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiocoder authored Jun 3, 2024
1 parent c1053e8 commit 417fb19
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 38 deletions.
103 changes: 65 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,65 @@
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

First, run the development server:

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

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.

[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.

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

## 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.
<div align="center">
<h1>🖥️ - Claudio Coder Blog - 📱</h1>
</div>

![landing](./resources/LandingHomePage.png)

<img width=90 alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/claudiocoder/claudio_coder_page/ui.yml?branch=main">
<img width=110 alt="Vercel Deployment" src="https://deploy-badge.vercel.app/vercel/claudio-coder-page-9jtcve6fo-claudiocoders-projects?style=plastic&name=UI">

<div>

## Description
Claudio Coder Personal Blog is a personal blog platform where I share my thoughts, experiences, and knowledge about coding, technology, and software development. This project aims to provide insightful content for developers of all levels, offering tutorials, code snippets, and articles on various tech topics.

## Main Features
- **Responsive Design**: Accessible on all devices, ensuring a great reading experience on desktops, tablets, and mobile phones.
- **Syntax Highlighting**: Enhanced code readability with syntax highlighting for various programming languages.
- **SEO Optimized**: Improved search engine visibility for better reach.

## Technologies Used
- **Frontend**: Next.js
- **Backend**: Node.js
- **Styling**: Tailwind
- **Deployment**: Vercel


## Installation
1. Clone the repository:
```sh
git clone https://github.com/claudiocoder/claudio_coder_page.git
cd claudio-coder-page
```
2. Install dependencies:
```sh
npm install
```
3. Start the application:
```sh
npm run dev
```
5. Visit `http://localhost:3000` in your browser to see the blog in action.

## Usage
Once installed, you can use the following commands:
- **Start Development Server**:
```sh
npm run dev
```
- **Build for Production**:
```sh
npm run build
```
- **Run Tests**:
```sh
npm test
```

## Contribution
Contributions are welcome! Please follow these steps:
1. Fork the project.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/YourFeature`).
6. Open a Pull Request.
Binary file added resources/LandingHomePage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 417fb19

Please sign in to comment.