Skip to content

Commit 7e8b778

Browse files
rbuelsrbuels
committed
remove extraneous things from the root README
1 parent a9ed2a9 commit 7e8b778

File tree

1 file changed

+2
-194
lines changed

1 file changed

+2
-194
lines changed

‎README.md‎

Lines changed: 2 additions & 194 deletions
Original file line numberDiff line numberDiff line change
@@ -1,194 +1,6 @@
11
# MCG Take-Home Project
22

3-
Started by Robert Buels at 3:45pm 2/21/25, based on the [FastAPI full stack template](https://fastapi.tiangolo.com/project-generation/)
4-
5-
### Dashboard Login
6-
7-
[![API docs](img/login.png)](https://github.com/fastapi/full-stack-fastapi-template)
8-
9-
### Dashboard - Admin
10-
11-
[![API docs](img/dashboard.png)](https://github.com/fastapi/full-stack-fastapi-template)
12-
13-
### Dashboard - Create User
14-
15-
[![API docs](img/dashboard-create.png)](https://github.com/fastapi/full-stack-fastapi-template)
16-
17-
### Dashboard - Items
18-
19-
[![API docs](img/dashboard-items.png)](https://github.com/fastapi/full-stack-fastapi-template)
20-
21-
### Dashboard - User Settings
22-
23-
[![API docs](img/dashboard-user-settings.png)](https://github.com/fastapi/full-stack-fastapi-template)
24-
25-
### Dashboard - Dark Mode
26-
27-
[![API docs](img/dashboard-dark.png)](https://github.com/fastapi/full-stack-fastapi-template)
28-
29-
### Interactive API Documentation
30-
31-
[![API docs](img/docs.png)](https://github.com/fastapi/full-stack-fastapi-template)
32-
33-
## How To Use It
34-
35-
You can **just fork or clone** this repository and use it as is.
36-
37-
✨ It just works. ✨
38-
39-
### How to Use a Private Repository
40-
41-
If you want to have a private repository, GitHub won't allow you to simply fork it as it doesn't allow changing the visibility of forks.
42-
43-
But you can do the following:
44-
45-
- Create a new GitHub repo, for example `my-full-stack`.
46-
- Clone this repository manually, set the name with the name of the project you want to use, for example `my-full-stack`:
47-
48-
```bash
49-
git clone [email protected]:fastapi/full-stack-fastapi-template.git my-full-stack
50-
```
51-
52-
- Enter into the new directory:
53-
54-
```bash
55-
cd my-full-stack
56-
```
57-
58-
- Set the new origin to your new repository, copy it from the GitHub interface, for example:
59-
60-
```bash
61-
git remote set-url origin [email protected]:octocat/my-full-stack.git
62-
```
63-
64-
- Add this repo as another "remote" to allow you to get updates later:
65-
66-
```bash
67-
git remote add upstream [email protected]:fastapi/full-stack-fastapi-template.git
68-
```
69-
70-
- Push the code to your new repository:
71-
72-
```bash
73-
git push -u origin master
74-
```
75-
76-
### Update From the Original Template
77-
78-
After cloning the repository, and after doing changes, you might want to get the latest changes from this original template.
79-
80-
- Make sure you added the original repository as a remote, you can check it with:
81-
82-
```bash
83-
git remote -v
84-
85-
origin [email protected]:octocat/my-full-stack.git (fetch)
86-
origin [email protected]:octocat/my-full-stack.git (push)
87-
upstream [email protected]:fastapi/full-stack-fastapi-template.git (fetch)
88-
upstream [email protected]:fastapi/full-stack-fastapi-template.git (push)
89-
```
90-
91-
- Pull the latest changes without merging:
92-
93-
```bash
94-
git pull --no-commit upstream master
95-
```
96-
97-
This will download the latest changes from this template without committing them, that way you can check everything is right before committing.
98-
99-
- If there are conflicts, solve them in your editor.
100-
101-
- Once you are done, commit the changes:
102-
103-
```bash
104-
git merge --continue
105-
```
106-
107-
### Configure
108-
109-
You can then update configs in the `.env` files to customize your configurations.
110-
111-
Before deploying it, make sure you change at least the values for:
112-
113-
- `SECRET_KEY`
114-
- `FIRST_SUPERUSER_PASSWORD`
115-
- `POSTGRES_PASSWORD`
116-
117-
You can (and should) pass these as environment variables from secrets.
118-
119-
Read the [deployment.md](./deployment.md) docs for more details.
120-
121-
### Generate Secret Keys
122-
123-
Some environment variables in the `.env` file have a default value of `changethis`.
124-
125-
You have to change them with a secret key, to generate secret keys you can run the following command:
126-
127-
```bash
128-
python -c "import secrets; print(secrets.token_urlsafe(32))"
129-
```
130-
131-
Copy the content and use that as password / secret key. And run that again to generate another secure key.
132-
133-
## How To Use It - Alternative With Copier
134-
135-
This repository also supports generating a new project using [Copier](https://copier.readthedocs.io).
136-
137-
It will copy all the files, ask you configuration questions, and update the `.env` files with your answers.
138-
139-
### Install Copier
140-
141-
You can install Copier with:
142-
143-
```bash
144-
pip install copier
145-
```
146-
147-
Or better, if you have [`pipx`](https://pipx.pypa.io/), you can run it with:
148-
149-
```bash
150-
pipx install copier
151-
```
152-
153-
**Note**: If you have `pipx`, installing copier is optional, you could run it directly.
154-
155-
### Generate a Project With Copier
156-
157-
Decide a name for your new project's directory, you will use it below. For example, `my-awesome-project`.
158-
159-
Go to the directory that will be the parent of your project, and run the command with your project's name:
160-
161-
```bash
162-
copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
163-
```
164-
165-
If you have `pipx` and you didn't install `copier`, you can run it directly:
166-
167-
```bash
168-
pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust
169-
```
170-
171-
**Note** the `--trust` option is necessary to be able to execute a [post-creation script](https://github.com/fastapi/full-stack-fastapi-template/blob/master/.copier/update_dotenv.py) that updates your `.env` files.
172-
173-
### Input Variables
174-
175-
Copier will ask you for some data, you might want to have at hand before generating the project.
176-
177-
But don't worry, you can just update any of that in the `.env` files afterwards.
178-
179-
The input variables, with their default values (some auto generated) are:
180-
181-
- `project_name`: (default: `"FastAPI Project"`) The name of the project, shown to API users (in .env).
182-
- `stack_name`: (default: `"fastapi-project"`) The name of the stack used for Docker Compose labels and project name (no spaces, no periods) (in .env).
183-
- `secret_key`: (default: `"changethis"`) The secret key for the project, used for security, stored in .env, you can generate one with the method above.
184-
- `first_superuser`: (default: `"[email protected]"`) The email of the first superuser (in .env).
185-
- `first_superuser_password`: (default: `"changethis"`) The password of the first superuser (in .env).
186-
- `smtp_host`: (default: "") The SMTP server host to send emails, you can set it later in .env.
187-
- `smtp_user`: (default: "") The SMTP server user to send emails, you can set it later in .env.
188-
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
189-
- `emails_from_email`: (default: `"[email protected]"`) The email account to send emails from, you can set it later in .env.
190-
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
191-
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
3+
Started by Robert Buels at 3:45pm 2/21/25, based on the [FastAPI full stack template](https://fastapi.tiangolo.com/project-generation/).
1924

1935
## Backend Development
1946

@@ -208,10 +20,6 @@ General development docs: [development.md](./development.md).
20820

20921
This includes using Docker Compose, custom local domains, `.env` configurations, etc.
21022

211-
## Release Notes
212-
213-
Check the file [release-notes.md](./release-notes.md).
214-
21523
## License
21624

217-
The Full Stack FastAPI Template is licensed under the terms of the MIT license.
25+
This is a fork of the Full Stack FastAPI Template and is licensed under the terms of the MIT license.

0 commit comments

Comments
 (0)