Transistor

Transistor is an open source customizable RSS feed reader based on Mosfet by N-O-D-E.
Read the docs »

Visit site · Report Bug · Request Feature/Language

Table of Contents

• Table of Contents
• About The Project
  • Built With:
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Contact
• Acknowledgements

About The Project

Built With:

• React - TypeScript
• Next JS
• Styled Components

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and some help on how to install them.

• pnpm and nvm

npm install pnpm@latest -g

Installation

1. Clone the transistor repo

git clone https://github.com/Casm101/transistor

2. Install PNPM packages

pnpm install

3. Run the development server (localhost)

pnpm run dev

4. The development server will be accessable via:

http://localhost:3000/

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Create a new branch using the following scheme: (git branch YOUR_NAME/REASON/SPECIFIC_DETAIL)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin feature/AmazingFeature)
4. Open a Pull Request and a Reviewer

Contact

Christian Smith Mantas - @casm_101 - casm202@gmail.com

Project Link: https://github.com/Casm101/transistor

Acknowledgements

• Christian Smith Mantas
• N-O-D-E