diff --git a/README.md b/README.md index 14fcc74f..aab04779 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ -# **[Javaistic](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-header&utm_campaign=javaistic) ![Stars](https://badgen.net/github/stars/javaistic/javaistic) ![Release](https://badgen.net/github/release/javaistic/javaistic) [![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml)** +

+ +
+ + + + +
+ +### [![Stars](https://badgen.net/github/stars/javaistic/javaistic)](https://github.com/javaistic/javaistic/stargazers) [![Release](https://badgen.net/github/release/javaistic/javaistic)](https://github.com/javaistic/javaistic/releases) [![CodeQL](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml) [![License](https://badgen.net/github/license/javaistic/javaistic)](LICENSE) [![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/8a3u.svg)](https://javaistic.betteruptime.com/?utm_source=status_badge) + +
+ +
[![javaistic](.github/img/javaistic-readme.png)](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-image&utm_campaign=javaistic) -### **Javaistic - Java learning made simple.**

-## **Website : [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic)** +## Website ⟶ [javaistic.vercel.app](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-link&utm_campaign=javaistic) -## **[Site Status](https://javaistic.betteruptime.com/) [![Better Uptime Badge](https://betteruptime.com/status-badges/v1/monitor/8a3u.svg)](https://betteruptime.com/?utm_source=status_badge)** +## About + +A Java Programming learning website packed with information and programs ranging from basics , arrays , string programs to 2D arrays , recursion , matrices and many more. + +## [Site Status](https://javaistic.betteruptime.com/) ![Stats](https://badgen.net/uptime-robot/status/m788498503-abfbb35c24db9355ed897d6d) ![Stats](https://badgen.net/uptime-robot/day/m788498503-abfbb35c24db9355ed897d6d) @@ -18,15 +34,51 @@ ![Stats](https://badgen.net/uptime-robot/month/m788498503-abfbb35c24db9355ed897d6d) ![Stats](https://badgen.net/uptime-robot/response/m788498503-abfbb35c24db9355ed897d6d) -## **Description** -A Java Programming learning website packed with information and programs ranging from basics , arrays , string programs to 2D arrays , recursion , matrices and many more. +## Contributing +If you're interested in contributing to Javaistic Documentation, please read our [contributing docs](CONTRIBUTING.md) before submitting a pull request. + +## For developing locally + +Javaistic uses [Next.js](https://nextjs.org/) for its documentation. Here is how you can run the project locally: + +1. Clone this repo + + ```sh + git clone https://github.com/javaistic/javaistic.git + ``` + +2. Go into the project root directory + + ```sh + cd javaistic + ``` + +3. Install JS dependencies + + ```sh + yarn + ``` + +4. Start the dev server + + ```sh + yarn dev + ``` + +## Community + +The Javaistic community can be found on [GitHub Discussions](https://github.com/javaistic/javaistic/discussions), where you can ask questions, voice ideas, and share your projects. + +To chat with other community members, you can join the [Javaistic Discord](https://javaistic.vercel.app/discord) -## **[License](LICENSE)** +Our [Code of Conduct](CODE_OF_CONDUCT.md) applies to all Javaistic community channels. + -![License](https://badgen.net/github/license/javaistic/javaistic) +## Author +- Arghya Ghosh [(@uiuxarghya)](https://twitter.com/uiuxarghya) -## **Sponsors** +## Sponsors A special thanks to our sponsors: