[go: up one dir, main page]

Skip to content

Rotion is an alternative to Notion built for learning proposes with Electron.

Notifications You must be signed in to change notification settings

amanda-santos/rotion

Repository files navigation

Rotion

GitHub top language Repository size GitHub last commit Repository issues

About the project   |    Layout   |    Technologies   |    Preview   |    Getting started   |    How to contribute   

📝 About the project

Rotion is an alternative to Notion built for learning proposes with Electron. The application is available in English 🇬🇧.

Developed during the course Desktop Apps with Electron by Rocketseat. 🚀

🎨 Layout

Click here to check the layout on Figma.

👩🏻‍💻 Technologies

Technologies used to develop this project:

  • Electron
  • TypeScript
  • React
  • TailwindCSS
  • React Query
  • TipTap Editor
  • Phosphor Icons

🖥 Preview

preview.mp4

⌨ Getting started

  • Run npm i to install the dependencies
  • Open the application with npm run dev

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork amanda-santos/rotion

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd rotion

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch


Made with 💜 by Amanda Santos