diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..7b84e87a --- /dev/null +++ b/.dockerignore @@ -0,0 +1,7 @@ +Dockerfile +.dockerignore +node_modules +npm-debug.log +dist +.git +.env \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..94c10b19 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,10 @@ +FROM node:18-alpine + +WORKDIR /usr/src/app +COPY package.json . +RUN yarn install +COPY . . + +EXPOSE 3000 + +CMD ["yarn", "start"] \ No newline at end of file diff --git a/README.md b/README.md index 0b9b4f15..1b39e441 100644 --- a/README.md +++ b/README.md @@ -1,125 +1,103 @@ # Open-Set-Go_client

-Open-Set-Go Logo +Open-Set-Go Logo

- Start Open-Source Projects easily, quickly and conveniently with Open-Set-Go! + This is Open-Set-Go's React Client Server Repository! More details at Open-Set-Go Repository!

- node Version - License + node Version Sonar Cloud Scan - - + Fossa License Scan - Slack - contributors - Open-Set-Go_client stars - Open-Set-Go_client stars - + w3c validation check + Netlify status + Slack + github release + github last release date + github commits + github License + github contributors + github stars + GitHub closed pull requests + GitHub closed issues

-
+## Description -## What is the **Open-Set-Go**? +**Open-Set-Go_client** repository is source code of Open-Set-Go's **React** Server!
+You can see more information of our topic on [**Open-Set-Go**](https://github.com/AgainIoT/Open-Set-Go) Repository. -**Open-Set-Go** is the `Open-Source Project Starting toolkit` for Open-Source Developers. +This repository is not about the direction and theme of Open-Set-Go, but about where we're going to go and what improvements we're going to make to our react servers! -0. Log in with your GitHub ID(GitHub OAuth2)!
- This project is subordinate to GitHub and is being developed on the basis of launching an Open-Source project on GitHub. Therefore, you can log-in to Open-Set-Go with your GitHub ID. +> If you want to discuss the topic, please use [Discussions from **Open-Set-Go**](https://github.com/AgainIoT/Open-Set-Go/discussions)! -1. Create Repository
- Create a repository to start a new open-source project. You can choose the environment(_e.g., programming language, framework, gitignore, etc._) for your project. Then, your project's environment will be set! +## Installation & Development Environment -2. Add License
- Allows you to determine and select a license based on the information provided about it. +| Supported Environment | Version | Description | +| --------------------- | ------------ | --------------------------------------------- | +| Ubuntu OS | Ubuntu 22.04 | Open-Set-Go_client was developed by Ubuntu OS | +| Node.js | >= 18.x | @ocotokit/rest >= node v18.x | +| yarn | 1.22.19 | Open-Set-Go client manage package with yarn | -3. Add Pull-Request Template
- Provides PR templates of several famous open-source projects so that users can create meaningful PR templates. +### Install with script -4. Add Issue Templates
- Provides Issue Template references for several well-known open-source projects for different situations, making it easy for users to create an Issue Template. +You can also easily install it through [install.sh](https://github.com/AgainIoT/Open-Set-Go#installation--development-environment)! -5. Create CONTRIBUTING.md
- Provides references to Contributing.md for several well-known open-source projects, while also making it easy to create CONTRIBUTING.md through markdown previewer. +### Install with docker -6. Create README.md
- Provides references to README.md for several well-known open-source projects, while also making it easy to create README.md through markdown previewer. +1. Pull our docker image! -## Why **Open-Set-Go**? + ``` + docker pull ymw0407/open-set-go_client + ``` -It is not just to create a Source-Open Project, but to create a contribution-friendly environment and create an environment where communication between developers and contributors is smooth to create sustainable open source projects.
-In addition, **Open-Set-Go** makes it easy, fast, and simple to build a contribution-friendly environment at the start of an open-source project. +2. Create `.env` file at root to use secret environment -## Vision of **Open-Set-Go** + > See more details at [EnvironmentVariable.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/EnvironmentVariable.md) -Can see our vision for the foreseeable future at our project's milestone.
+3. Start Open-Set-Go Client's docker with environment variable! -- Open-Set-Go -- Open-Set-Go client -- Open-Set-Go server +### Install Manually -### Final Vision of Open-Set-Go +1. Clone our Repository! -Open-Set-Go makes it easy, fast and simple to start an Open-Source project, while also sharing your own contribution environment and becoming a community driving the Open-Source trend. _Like GitHub._ + ```bash + git clone https://github.com/AgainIoT/Open-Set-Go_client.git + ``` -## Installation & Development Environment +2. Install the Development Environment -| Supported Environment | Version | Description | -| --------------------- | ---------------- | ---------------------------------------------------- | -| Windows | Windows 11 | Open-Set-Go_client was developed by Windows 11 | -| Node.js | >= 18.x | styled-reset require >= node v18.x | -| yarn | 1.22.19 | Open-Set-Go server & client manage package with yarn | +3. Install Node Dependencies + ```bash + yarn install + ``` +4. Create `.env` file at root to use secret environment + > See more details at [EnvironmentVariable.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/EnvironmentVariable.md) -1. Clone our Repository! - ```bash - git clone https://github.com/AgainIoT/Open-Set-Go_client.git +5. Start Open-Set-Go Server - ###################################### - # Open-Set-Go Repository Dependencies - # - # Open-Set-Go_client - # - ###################################### - ``` + ```bash + # for development + yarn start + yarn start:linux # start HTTPS for linux + yarn start:wins # start HTTPS for windows -2. Install the Development Environment - -3. Install Node Dependencies - ```bash - yarn install - ``` -4. Create your own github-oauth app - - Follow the [GitHub Docs](https://docs.github.com/ko/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) to get Client ID & Client Secret.
- If your Authorization URL should be `localhost:3000` ! - -5. Create `.env` file at root to use secret environment - ```bash - touch .env - ``` - -6. Fill in the `.env` file as follows. - ```bash - REACT_APP_CLIENT_ID="" - REACT_APP_REDIRECT_URL="http://localhost:3000/login" - REACT_APP_SERVER_URL="http://localhost:8080" - ``` - -7. Start Open-Set-Go Server - ```bash - yarn start - ``` + # for production + yarn build + yarn global add serve + serve -s build + ``` ## Documentation We are conducting documentation at Open-Set-Go.io. Please refer to the following. _You can see our technical blog & showcase on Open-Set-Go.io_ -- Open-Set-Go.io +- Open-Set-Go.io ## Contributing @@ -130,9 +108,6 @@ Also, we are recruiting collaborators, so if you are interested, please join our Thank you to everyone who contributed to our project. - -### Open-Set-Go_client -