Skip to content

Commit

Permalink
Version 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dorukerenaktas committed May 11, 2019
1 parent eec9be3 commit a0acb61
Show file tree
Hide file tree
Showing 206 changed files with 13,784 additions and 805 deletions.
17 changes: 17 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# build environment
FROM node:9.6.1 as builder
RUN mkdir /usr/src/app
WORKDIR /usr/src/app
ENV PATH /usr/src/app/node_modules/.bin:$PATH
COPY package.json /usr/src/app/package.json
RUN npm install --silent
RUN npm install react-scripts@1.1.1 -g --silent
COPY . /usr/src/app
RUN npm run build

# production environment
FROM nginx:1.13.9-alpine
COPY default.conf /etc/nginx/conf.d/default.conf
COPY --from=builder /usr/src/app/build /usr/share/nginx/html
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 notbook.net

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
117 changes: 92 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,111 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
<a href="http://notbook.net"><img width="300" src="https://i.ibb.co/BgKrd7q/notbook-logo.png" title="notbook." alt="notbook."></a>

## Available Scripts
<!-- [![notbook.](https://i.ibb.co/BgKrd7q/notbook-logo.png)](http://notbook.net) -->

In the project directory, you can run:
*Student sharing platform web client. Built with Typescript and React.*

### `npm start`
[![Build Status](https://travis-ci.com/dorukBen/notbook-client.svg?branch=master)](https://travis-ci.com/dorukBen/notbook-client)
[![Docker Automated](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/dorukben/notbook-client)
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
> Tips
The page will reload if you make edits.<br>
You will also see any lint errors in the console.
- Want to develop with running backend checkout: <a href="https://github.com/dorukBen/notbook-server">notbook-server<a/>
- Checkout docker built: <a href="https://hub.docker.com/r/dorukben/notbook-client">notbook-server<a/>
- Suggested IDE: <a href="https://www.jetbrains.com/webstorm/">Webstorm<a/>

### `npm test`
## Table of Contents
- [Installation](#installation)
- [Contributing](#contributing)
- [Team](#team)
- [FAQ](#faq)
- [Contact](#contact)
- [License](#license)

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
## Installation
- Requirements: `git` & `npm`

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

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
### Development
- Install dependencies
```shell
$ npm i
```

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
- Start development server with standalone fake data
```shell
$ npm start
```

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
- If you want to develop with live backend you can use
```shell
$ REACT_APP_NO_FAKE=true npm start
```

### `npm run eject`
### Build
- Local build using npm
```shell
$ npm build
```

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
- Build with docker
```shell
$ docker build -t <your-build-name> .
```

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
## Contributing
> So, you want to contribute COOL!
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
### Step 1

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
- Fork the repository

## Learn More
### Step 2
- **HACK AWAY!**

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
### Step 3
- Create a new pull request using <a href="https://github.com/dorukBen/notbook-client/compare/" target="_blank">`https://github.com/dorukBen/notbook-client/compare/`</a>.

To learn React, check out the [React documentation](https://reactjs.org/).
## Team
> Want to get into the team mail us `team@notbook.net`

| <a href="https://github.com/dorukBen" target="_blank">**Doruk**</a> | <a href="" target="_blank">**New Member**</a> |
| :---------------------------------------------------------------: | :---------------------------------------------------------------: |
| <img width="100" src="https://avatars2.githubusercontent.com/u/20422563?s=400"/> | <img width="100" src=""/> |
| <a href="https://github.com/dorukBen" target="_blank">`github.com/dorukBen`</a> | <a href="" target="_blank">`github.com/newMember`</a> |

- 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 <a href="www.linkedin.com/in/doruk-eren-aktaş" target="_blank">`Doruk Eren AKTAŞ`</a>
- Mail at <a href="mailto:dorukerena@gmail.com?Subject=Hello" target="_blank">`dorukerena@gmail.com`</a>

---

## Donations
- Wanna buy me a beer ?

<a href="https://www.patreon.com/notbook"><img width="200" alt="Support via Patreon" src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png"><a/>

---

## License
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
- Copyright 2019 © <a href="http://notbook.net" target="_blank">notbook.</a>
12 changes: 12 additions & 0 deletions default.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
server {
listen 80;
location / {
root /usr/share/nginx/html;
index index.html index.htm;
try_files $uri $uri/ /index.html;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}
Loading

0 comments on commit a0acb61

Please sign in to comment.