Skip to content

Vardan2009/lumina

Repository files navigation

Lumina

project-image

Lumina is a very lightweight code editor aiming for simplicity.

shieldsshieldsshieldsshieldsshields

Project Screenshots:

project-screenshot project-screenshot project-screenshot project-screenshot

🧐 Features

Here're some of the project's best features:

  • Syntax Highlighting
  • File reading writing deleting e.t.c
  • Preferences Tab
  • File Icons

🛠️ Installation Steps:

1. Clone the repo

git clone https://github.com/Vardan2009/lumina.git

2. Install packages for Electron

(in /package.json) npm install

3. Install packages for React

(in /lumina/package.json) npm install

4. Run React app (only for development not for production)

(in /lumina) npm start

5. Run Electron app

(in /) npm run startonce

💻 Built with

Technologies used in the project:

  • ElectronJS
  • ReactJS
  • TypeScript
  • CSS

🍰 Contribution Guidelines:

Thank you for considering contributing to our project! Please follow these guidelines to ensure a smooth collaboration:

How to Contribute

  1. Fork the repository.
  2. Create a new branch for your contribution.
  3. Make your changes or additions.
  4. Test your changes thoroughly.
  5. Submit a pull request (PR) to the main repository.
  6. Provide a clear description of your changes in the PR.

Code Style

  • Follow the existing code style and formatting.
  • Write clear and concise code with comments where necessary.
  • Make sure your code is compatible with the project's dependencies.

Reporting Issues

  • Check if the issue has already been reported before creating a new one.
  • Provide detailed information about the issue, including steps to reproduce it.
  • Use clear and descriptive titles for your issues.

Communication

  • Respect other contributors and maintain a friendly atmosphere.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.