InkSpace

Fullstack React Web Application written in TypeScript
View Demo · Backend · Report Bug · Suggestion

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

To run this app, you'll need NodeJS on your system.

If you don't have NodeJS installed, no worries! Just visit the amazing new NodeJS installation guide and you'll find all the info you need to get started.

Installation

1. Go to inkspace_backend and follow installation steps there first

2. Once you're done with the fist step clone the repo

   git clone https://github.com/andriinero/inkspace.git

3. Go to the cloned repo and install NPM packages

   npm install

4. After installing packages you can start your local server

   npm run dev

   NOTE: If the new tab didn't open in your browser, visit http://localhost:5173 to see the app

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)