{"id":19164998,"url":"https://github.com/selfboot/nahan","last_synced_at":"2025-05-07T12:21:59.570Z","repository":{"id":70625935,"uuid":"62485022","full_name":"selfboot/NaHan","owner":"selfboot","description":"A simple BBS forum based on flask,  mainly for learning Web Design.","archived":false,"fork":false,"pushed_at":"2016-09-08T10:36:49.000Z","size":920,"stargazers_count":118,"open_issues_count":3,"forks_count":38,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-19T22:02:21.172Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/selfboot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-03T06:53:56.000Z","updated_at":"2024-10-31T10:52:50.000Z","dependencies_parsed_at":"2023-03-10T22:15:19.132Z","dependency_job_id":null,"html_url":"https://github.com/selfboot/NaHan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2FNaHan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2FNaHan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2FNaHan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selfboot%2FNaHan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/selfboot","download_url":"https://codeload.github.com/selfboot/NaHan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252874209,"owners_count":21817780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T09:26:01.443Z","updated_at":"2025-05-07T12:21:59.535Z","avatar_url":"https://github.com/selfboot.png","language":"Python","readme":"# NaHan: A Tiny Forum.\n\n[NaHan](http://bbs.selfboot.cn/) is a tiny forum written by Python flask and bootstrap.  Its goal is to learn flask and web development in practice.\n\nTopic page:\n\n![][1]\n\nAdmin page:\n\n![][2]\n\n# Features\n\nMajor features:\n\n1. Whole user manage system, containing registration, login, password change, retrieve;\n2. Topic management system, login users can create topics, append topics, have comments on topics.\n3. Markdown support in topic, appendix of topic and comment.\n4. Can use `@someone` to remind other user anywhere.  The user which be is reminded will receive notify.\n5. A convenient administrator system, super user can block or activate users, topics, nodes and comments.\n6. A simple keyword search engine, one can search some specific topics.\n\nYou can sign up for an account and have a explore as normal user.  You can even login as an administrator in [admin page](http://bbs.selfboot.cn/admin/) with username 1291023320@qq.com, password 1.  Then you can try to block some topics(comments and users as well) and reactive them again.\n\n# How to Run\n\n1. Firstly, make sure all the relevant modules installed.\n\n    You'd better use [virtualenv](https://virtualenv.pypa.io/en/stable/) to create a isolated python environments, and then use pip to install all the requirements.\n    \n        pip install -r requirements.txt\n        \n2. Do some custom configure in `config.py`, have a glance as followers:\n\n        # flask config\n        SECRET_KEY = os.environ.get('SECRET_KEY') or '!@#$%^\u0026*12345678'\n        \n        # Config about senting email.\n        MAIL_SERVER = 'smtp.qq.com'\n        MAIL_PORT = 465\n        MAIL_USE_SSL = True\n        MAIL_USERNAME = os.environ.get('MAIL_USERNAME')\n        MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD')\n        FORUM_MAIL_SUBJECT_PREFIX = 'NaHan'\n        FORUM_MAIL_SENDER = 'Nahan \u003cselfboot@qq.com\u003e'\n\n        # Optional, setting about translation.\n        BABEL_DEFAULT_LOCALE = 'zh'\n        BABEL_DEFAULT_TIMEZONE = 'CST'\n        \n        # Some config about forum, containing pagination page size, saving position and limit of avatar.\n        PER_PAGE = 10   \n        UPLOAD_FOLDER = os.path.join(basedir, 'nahan/static/upload')\n        ALLOWED_EXTENSIONS = set(['png', 'jpg', 'jpeg'])\n        MAX_CONTENT_LENGTH = 512 * 1024\n        \n        # Database setting.\n        SQLALCHEMY_DATABASE_URI = (os.environ.get('DEV_DATABASE_URL') or\n                               'mysql://root:******@localhost/nahan')\n\n3. Start corresponding database service.\n\n    In MacOS, start mysql using the following command:\n    \n        mysql.server start\n         \n4. Go to the project's directory, run `python manage.py runserver`. \n\nFor more about how to run a flask project, you need to have much knowledge about flask, [docs](http://flask.pocoo.org/docs/0.11/) can be found here. \n\n[1]: picture/front_page.png\n[2]: picture/admin_page.png\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselfboot%2Fnahan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fselfboot%2Fnahan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselfboot%2Fnahan/lists"}