Web Development of CSSA - University of Windsor Chinese Student & Scholar Association

project_description
Explore the docs »
The UWCSSA project is a web development project designed to provide an efficient working platform for the University of Windsor Chinese Students and Scholars Association and a student forum for University of Windsor students.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Motiation
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributors
6. Contributing
7. License
8. Contact
9. Support
10. Acknowledgements
11. KerunPanNotes

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email, project_title, project_description

Motiation

• To optimize the management of the student council (UWINCSSA) as well as its efficient operation.
• To build relationships among the student council, students and the local community and have them engaged.
• To improve accessibility.

Built With

• 
  
• 
  
• 
  
• 
  
• 
  
• 
  
• 
  
• 
  
• 
  

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

1. Clone the repo

   git clone https://github.com/ShenShu2016/uwcssa_ca.git

2. Prepare & start Frontend Docker Contanier

   cd ../uwcssa_ca/frontend
   docker-compose -f docker-compose.dev.yml build
   docker-compose -f docker-compose.dev.yml up

3. Prepare & start Backend & PostgreSQL Docker Contaniers

   cd ../uwcssa_ca/backend
   docker-compose -f docker-compose.dev.yml build
   docker-compose -f docker-compose.dev.yml up

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributors

The following people have contributed to the project:

• Shen Shu
• Kerun Pan
• Shikai(Zoe) Jin
• Jinhua Long
• ChangkuanGao
• Fanyu Zeng
• Heng Wei
• Changye Ma
• Yanhao Wang
• Chengyue Wei
• Mike Yu

Contributing

First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Please adhere to this project's code of conduct.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Home Page - @UWCSSA.ca

Project Link: https://github.com/ShenShu2016/uwcssa_ca

Support

Contributions, issues, and feature requests are welcome!

Give a ⭐️ if you like this project!

Acknowledgements

• amazing-github-template

KerunPanNotes

• Note this section just contains some hints, you guys can edit it if you want, or use this as a template to update our README file

hadolint

1. Check Docker images security level hadolint https://github.com/hadolint/hadolint

2. Open git bash to run

docker run --rm -i hadolint/hadolint < Dockerfile.dev

iteract with docker container

1. Check current running container

docker ps -a

2. iteract with the container by ID

docker exec -it [containerID] bash

open django shell terminal

1. Using it for testing django features

python manage.py shell

open redis cli terminal

1. Using it for testing redis features

docker exec -it [containerID] redis-cli