Skip to content

Commit 55d786f

Browse files
Update README.md
1 parent 8ed3a7d commit 55d786f

1 file changed

Lines changed: 19 additions & 16 deletions

File tree

Old banking website/README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> [!IMPORTANT]
2+
> Don't use this, it is OUTDATED, UNTESTED and USELESS, [use this instead](https://github.com/DefinetlyNotAI/FlaskBank)
3+
14
# Hackathon Banking API
25

36
A ready-to-use banking API server for hackathon projects. This Flask-based API provides a comprehensive set of features
@@ -47,46 +50,46 @@ for managing virtual currencies, wallets, and transactions.
4750
### Installation
4851

4952
1. Clone the repository:
50-
\`\`\`
51-
git clone https://github.com/yourusername/hackathon-banking-api.git
52-
cd hackathon-banking-api
53-
\`\`\`
53+
```
54+
git clone https://github.com/DefinetlyNotAI/Code_DUMP.git
55+
```
56+
Then `cd` to the directory.
5457

5558
2. Create a virtual environment:
56-
\`\`\`
59+
```
5760
python -m venv venv
5861
source venv/bin/activate # On Windows: venv\Scripts\activate
59-
\`\`\`
62+
```
6063

6164
3. Install dependencies:
62-
\`\`\`
65+
```
6366
pip install -r requirements.txt
64-
\`\`\`
67+
```
6568

6669
4. Set up environment variables:
6770
Create a .env file in the root directory with:
68-
\`\`\`
71+
```
6972
POSTGRESQL_DB_URL=postgresql://username:password@localhost:5432/banking_db
7073
JWT_SECRET=your_jwt_secret_key
7174
FLASK_ENV=development
72-
\`\`\`
75+
```
7376

7477
5. Initialize the database:
75-
\`\`\`
78+
```
7679
flask db init
7780
flask db migrate -m "Initial migration"
7881
flask db upgrade
79-
\`\`\`
82+
```
8083

8184
6. Create an admin user:
82-
\`\`\`
85+
```
8386
flask create-admin --username admin --password secure_password
84-
\`\`\`
87+
```
8588

8689
7. Run the server:
87-
\`\`\`
90+
```
8891
flask run
89-
\`\`\`
92+
```
9093

9194
The API will be available at http://localhost:5000
9295

0 commit comments

Comments
 (0)