基于 Express + Three.js的 3D 球体抽奖程序

# Lottery program Annual dinner lottery program, 3D sphere raffle, support for configuration of prize information, import participants information by `Excel`, and export lottery results by `Excel` If programm is helpful for you😎😎😎, it will be greatful to comment us with⭐**star**⭐ 😘😘😘😍🥰🎉🎈🎃 [点击跳转至中文使用文档](https://github.com/moshang-xc/lottery/blob/master/README-ZH_CN.MD) > Try it now: [https://moshang-xc.github.io/lottery/](https://moshang-xc.github.io/lottery/) ## Technology Stack Technology stack: Node + Express + Three.js Server: Express + Node Web Page: Three.js, References to the official 3D example of `Three.js` ## Function Description: 1. The result can ben save and downloaded to excel synchronously🎉 2. The winner will not participate in the drawing, and the drawing person can be drawn again if he/she not on site🎁 3. Refresh or trun off the server will save the winner data and will not resrt the lottery data, only by click the reset button on the page can the lottery data be reset🧧 4. The number of prizes is able to configure🎈 5. After all the prizes have been drawn, you can continue to draw special prizes(For example:Red pockets, additional prizes, etc). By default, one is extracted at once🧨 ## Preview > Try it now: [https://moshang-xc.github.io/lottery/](https://moshang-xc.github.io/lottery/)     ## Install ``` git clone https://github.com/moshang-xc/lottery.git cd lottery # Server plugin installation cd server npm install # Front-end plugin installation cd ../product npm install # Package npm run build # Running npm run serve # Developing & debugging npm run dev ``` ## Directory Structure ``` Lottery ├── product │ ├── src │ │ ├── lottery │ │ │ └── index.js │ │ ├── lib │ │ ├── img │ │ ├── css │ │ └── data │ ├── package.json │ └── webpack.config.js ├── server │ ├── config.js │ ├── server.js │ └── package.js ``` > 1. product is Front-end page directory > 4. server is Server directory > 5. config is Profile for prize information ## Configuration Information ### Lottery personnel list information configuration The lottery list information is in the **`server/data/user.xlsx`** file, information could only fill in base on the format, file name and title are not able to revise ### Prize information configuration Prize information is filled in the **server/config.js** file, and the file name cannot be modified. **The configuration of the prizes is described as follows:** | Parameter | Value Type | Description | | --------- | ---------- | ------------------------------------------------------------ | | type | Number | Type of prize, unique identifier, 0 is the placeholder for the default special prize, other prizes cannot be used | | count | Number | Prizes amount | | text | String | Prizes name | | title | String | Prizes description | | img | String | Image URL of the prize, image is under**img** catalog | ```js // Prize information, the first item is reserved and cannot be modified. Other items can be modified as required // Prize in let prizes = [{ type: 0, count: 1000, title: "", text: "Special Price" }, { type: 1, count: 2, text: "Special Price" title: "Mystery jackpot" img: "../img/secrit.jpg" }, { type: 2, count: 5, text: "First prize" title: "Mac Pro", img: "../img/mbp.jpg" } ... ]; ``` ### The configuration of the number of prizes drawn each time **EACH_COUNT**It is used to configure the number of lottery draws each time, which corresponds to the prizes one by one. For example, the number of lottery draws corresponding to the above prize configuration is as follows： ```js const EACH_COUNT = [1, 1, 5]; ``` Configuration above means the order of the number of prizes to be drawn at one time is：one special prize per time, one grand prize per time and 5 first prize per time. ### Enterprise Identity Configuration This identification is used to display on the lottery card. ```js const COMPANY = "MoShang"; ``` ## Docker Deployment plan ### Summary This project is support to deploy by Docker. Docker is a platform with lightweight containerization, allows you to quickly deploy, test and run the applications. This text will introduce how to deploy the project by Docker. ### System Requirement Before you use the Docker to deploy the project, you need to ensure you have download below software: - Docker (Please refer Docker official file to get the installation instructions) - Docker Compose ### Installation 1. Download and unzip the source code for the project 2. Access the project directory after unzipped the file 3. Execute the following command to build the Docker mirror image: ``` ./build.sh [TAG] ``` It will use Dockerfile to set up the Docker mirror image named `lottery:[TAG]`. If no tag is specified, the 'latest' tag is used by default 4. Execute the following command to run the local container: ``` ./dev.sh [TAG] ``` This will start the container and deploy the application in the Docker container. You can test loacally to ensure all running fulently. Please be pay attention that all applicaiton in the container will monitor port 8888 and port 443. 5. Execute the following command to tag the Docker mirror image and push it to the remote Docker repository ``` ./tagpush.sh [TAG] ``` It will tag the Docker mirror image and push it to the remote Docker repository, please build up your repo at https://hub.docker.com/ if you want to us Docker official hub. 6. Ensure it has a file named `docker-compose.yml` and add below information: ``` version: '3.8' volumes: lottery_log: services: lottery: container_name: lottery expose: - 8888 ports: - "28458:8888" - "443:443" volumes: - "lottery_log:/var/log" image: "panda1024/lottery:[TAG]" restart: always ``` Kindly take note that `[TAG]` should be replaced with the name of the mirror image you pushed to the Docker repository 7. Run the following command in the project directory on the server to deploy the application using Docker Compose: ``` docker-compose up -d ``` This will start a Docker Compose stack and deploy the project into it. Note that port 8888 and port 443 of the container are mapped to port 8888 and port 443 on the server. If you wish to use a different port, please change the `docker-compose.yml` file accordingly. ## License MIT