-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
85 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,103 @@ | ||
| <p align="center"> | ||
| <a href="https://expresso-ts.com/" target="blank"><img src="https://github.com/expressots/expressots/blob/main/media/expressots.png" width="120" alt="Expresso TS Logo" /></a> | ||
| </p> | ||
| <a name="readme-top"></a> | ||
|
|
||
| # Expresso TS | ||
| <!-- PROJECT SHIELDS --> | ||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|
|
||
| A Typescript + [Node.js]("https://nodejs.org/en/") lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🚀 | ||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://github.com/othneildrew/Best-README-Template"> | ||
| <img src="https://github.com/expressots/expressots/blob/main/media/expressots.png" alt="Logo" width="120"> | ||
| </a> | ||
|
|
||
| <h3 align="center">ExpressoTS Official Documentation</h3> | ||
|
|
||
| <p align="center"> | ||
| Everything you need to know to build applications with ExpressoTS | ||
| <br /> | ||
| <a href="https://doc.expresso-ts.com/"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/expressots/expresso-site-doc/discussions">Let's discuss</a> | ||
| · | ||
| <a href="https://github.com/expressots/expresso-site-doc/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/expressots/expresso-site-doc/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li><a href="#about-the-project">About The Project</a></li> | ||
| <li><a href="#getting-started">Getting Started</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#support-the-project">Support the project</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| # About The Project | ||
|
|
||
| ExpressoTS is a [Typescript](https://www.typescriptlang.org/) + [Node.js](https://nodejs.org/en/) lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🐎 | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Here is our [Official Documentation](https://expresso-ts.com/) | ||
| - Checkout our [First Steps documentation](https://expresso-ts.com/docs/overview/first-steps) | ||
| - Our [CLI Documentation](https://expresso-ts.com/docs/category/cli) | ||
| - Here is our [Site](https://expresso-ts.com/) | ||
| - You can find our [Documentation here](https://doc.expresso-ts.com/) | ||
| - Checkout our [First Steps documentation](https://doc.expresso-ts.com/docs/overview/first-steps) | ||
| - Our [CLI Documentation](https://doc.expresso-ts.com/docs/cli/overview) | ||
|
|
||
| ## Questions | ||
| ## Contributing | ||
|
|
||
| For questions and support please use the Official [Discord Channel](https://discord.com/invite/PyPJfGK). We have a very active community there, that will be happy to help you. Post your questions in the channel called **HELP EXPRESSO TS** and forum called **help**. | ||
| Welcome to the ExpressoTS community, a place bustling with innovative minds just like yours. We're absolutely thrilled to have you here! | ||
| ExpressoTS is more than just a TypeScript framework; it's a collective effort by developers who are passionate about creating a more efficient, secure, and robust web ecosystem. We firmly believe that the best ideas come from a diversity of perspectives, backgrounds, and skills. | ||
|
|
||
| ## Issues | ||
| Why Contribute to Documentation? | ||
|
|
||
| The [Issue Reporting Channel](https://github.com/expressots/expressots/issues) is for bug report and feature request **only**. | ||
| - **Share Knowledge**: If you've figured out something cool, why keep it to yourself? | ||
| - **Build Your Portfolio**: Contributing to an open-source project like ExpressoTS is a great way to showcase your skills. | ||
| - **Join a Network**: Get to know a community of like-minded developers. | ||
| - **Improve the Product**: Help us fill in the gaps, correct errors, or make complex topics easier to understand. | ||
|
|
||
| Before you create an issue, please make sure you read the [Contribution Guidelines](CONTRIBUTING.md). | ||
| Ready to contribute? [Click here for more details...](https://github.com/expressots/expresso-site-doc/blob/main/CONTRIBUTING.md) | ||
|
|
||
| ## Support the project | ||
|
|
||
| Expresso TS is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to your support. If you'd like to help, please consider: | ||
| ExpressoTS is an independent open source project with ongoing development made possible thanks to your support. If you'd like to help, please consider: | ||
|
|
||
| - Become a **[sponsor on GitHub](https://github.com/sponsors/expressots)** | ||
| - Follow the **[organization](https://github.com/expressots)** on GitHub and Star ⭐ the project | ||
| - Subscribe to the Twitch channel: **[Richard Zampieri](https://www.twitch.tv/richardzampieri)** | ||
| - Join our **[Discord](https://discord.com/invite/PyPJfGK)** | ||
| - Contribute submitting **[issues and pull requests](https://github.com/expressots/expressots/issues/new/choose)** | ||
| - Share the project with your friends and colleagues | ||
| - Contribute submitting **[issues and pull requests](https://github.com/expressots/expresso-site-doc/issues)** | ||
| - Share the project with your friends and colleagues | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/expressots/expresso-site-doc/blob/main/LICENSE) for more information. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/expressots/expresso-site-doc?style=for-the-badge | ||
| [contributors-url]: https://github.com/expressots/expresso-site-doc/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/expressots/expresso-site-doc?style=for-the-badge | ||
| [forks-url]: https://github.com/expressots/expresso-site-doc/forks | ||
| [stars-shield]: https://img.shields.io/github/stars/expressots/expresso-site-doc?style=for-the-badge | ||
| [stars-url]: https://github.com/expressots/expresso-site-doc/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/expressots/expresso-site-doc?style=for-the-badge | ||
| [issues-url]: https://github.com/expressots/expresso-site-doc/issues | ||
| [license-shield]: https://img.shields.io/github/license/expressots/expresso-site-doc?style=for-the-badge | ||
| [license-url]: https://github.com/expressots/expresso-site-doc/blob/main/LICENSE | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://www.linkedin.com/company/expresso-ts/ | ||
| [product-screenshot]: images/screenshot.png |