Skip to content

dorukerenaktas/notbook-client

Repository files navigation

notbook.

Student sharing platform web client. Built with Typescript and React.

Build Status Docker Automated License

Tips

Table of Contents

Installation

  • Requirements: git & npm

Clone

  • Create directory and navigate into it
$ mkdir notbook-client
$ cd notbook-client
  • Clone this repo to your local machine using
$ git clone https://github.com/dorukBen/notbook-client.git

Development

  • Install dependencies
$ npm i
  • Start development server with standalone fake data
$ npm start
  • If you want to develop with live backend you can use
$ REACT_APP_NO_FAKE=true npm start

Build

  • Local build using npm
$ npm build
  • Build with docker
$ docker build -t <your-build-tag> .

Contributing

So, you want to contribute COOL!

Step 1

  • Fork the repository

Step 2

  • HACK AWAY!

Step 3

Team

Want to get into the team mail us team@notbook.net

Doruk New Member
github.com/dorukBen github.com/newMember
  • You need at least one pull request for team approval

FAQ

  • Why there is only YTÜ as a university?
    • Yıldız Technical University is our pilot school. More schools will be added stay tuned.

Contact

Reach out to me at one of the following places!


Donations

  • Wanna buy me a beer ?

Support via Patreon


License

Releases

No releases published

Packages

No packages published

Languages