README.md

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

Tips

• Want to develop with running backend checkout: notbook-server
• Checkout docker built: notbook-client
• Suggested IDE: Webstorm

Table of Contents

• Installation
• Contributing
• Team
• FAQ
• Contact
• License

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

• Create a new pull request using https://github.com/dorukBen/notbook-client/compare/.

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!

• LinkedIn at Doruk Eren AKTAŞ
• Mail at dorukerena@gmail.com

---

Donations

• Wanna buy me a beer ?

---

License

• MIT license
• Copyright 2019 © notbook.